sdks/dotnet/basyx-core/BaSyx.Models/Core/Common/IElementContainer.cs

/*******************************************************************************
* Copyright (c) 2020 Robert Bosch GmbH
* Author: Constantin Ziesche (constantin.ziesche@bosch.com)
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*******************************************************************************/
using BaSyx.Models.Core.AssetAdministrationShell.Identification;
using BaSyx.Models.Extensions;
using BaSyx.Utils.ResultHandling;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;

namespace BaSyx.Models.Core.Common
{
    public interface ICrudContainer<TIdentifier, TElement>
    {
        IResult<T> Create<T>(T element) where T : class, TElement;

        IResult<TElement> Retrieve(TIdentifier id);

        IResult<T> Retrieve<T>(TIdentifier id) where T : class, TElement;

        IResult<IQueryableElementContainer<T>> RetrieveAll<T>() where T : class, TElement;

        IResult<IQueryableElementContainer<T>> RetrieveAll<T>(Predicate<T> predicate) where T : class, TElement;

        IResult<TElement> CreateOrUpdate(TIdentifier id, TElement element);

        IResult<TElement> Update(TIdentifier id, TElement element);

        IResult Delete(TIdentifier id);
       
    }

    [JsonConverter(typeof(ElementContainerConverter))]
    public interface IElementContainer<TElement> : ICrudContainer<string, TElement>, IEnumerable<TElement>
    {
        TElement this[int i] { get; }
        TElement this[string idShort] { get; }

        IResult<IQueryableElementContainer<TElement>> RetrieveAll();
        IResult<IQueryableElementContainer<TElement>> RetrieveAll(Predicate<TElement> predicate);

        IEnumerable<IElementContainer<TElement>> Children { get; }
        IEnumerable<TElement> Values { get; }
        IElementContainer<TElement> ParentContainer { get; set; }

        IReferable Parent { get; set; }
        TElement Value { get; set; }
        string Path { get; set; }
        string IdShort { get; }
        bool IsRoot { get; }

        bool HasChildren();
        bool HasChild(string idShort);
        bool HasChildPath(string idShortPath);
        void Traverse(Action<TElement> action);
        IEnumerable<TElement> Flatten();
        IElementContainer<TElement> GetChild(string idShortPath);
        void AppendRootPath(string rootPath);
        void Add(TElement element);
        void Remove(string idShort);
        void AddRange(IEnumerable<TElement> elements);
    }
}