IObjectCollection.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// ACF includes
#include <istd/TIFactory.h>
#include <istd/TInterfacePtr.h>
 
// ImtCore includes
#include <imtbase/IObjectCollectionInfo.h>
#include <imtbase/IOperationContext.h>
 
 
namespace imtbase
{
 
 
class IHierarchicalStructure;
class IRevisionController;
class ICollectionDataController;
class IObjectCollectionIterator;
class IHierarchicalStructure;
 
 
class IObjectCollection: virtual public IObjectCollectionInfo
{
public:
       typedef istd::IChangeableSharedPtr DataPtr;
 
       static const QByteArray CN_OBJECT_DATA_CHANGED;
       typedef NotifierInfo ObjectDataChanged;
 
       enum ChangeFlags
       {
              CF_OBJECT_DATA_CHANGED = CF_LAST
       };
 
       enum OperationalFlags
       {
              OF_SUPPORT_RENAME = 1,
 
              OF_SUPPORT_INSERT = 2,
 
              OF_SUPPORT_DELETE = 4,
 
              OF_SUPPORT_EDIT = 8,
 
              OF_SUPPORT_USING = 16,
 
              OF_SUPPORT_PAGINATION = 32,
 
              OF_ALL = OF_SUPPORT_RENAME | OF_SUPPORT_INSERT | OF_SUPPORT_DELETE | OF_SUPPORT_EDIT | OF_SUPPORT_USING | OF_SUPPORT_PAGINATION
       };
 
       I_DECLARE_FLAGS(OperationalFlags, OF_SUPPORT_RENAME, OF_SUPPORT_INSERT, OF_SUPPORT_DELETE, OF_SUPPORT_EDIT, OF_SUPPORT_USING, OF_SUPPORT_PAGINATION, OF_ALL);
 
       class IDataFactory
       {
       public:
              virtual istd::IChangeableUniquePtr CreateInstance(const QByteArray& keyId = QByteArray()) const = 0;
              virtual istd::IFactoryInfo::KeyList GetFactoryKeys() const = 0;
       };
 
       virtual IHierarchicalStructure* GetCollectionStructure() const;
 
       virtual const IRevisionController* GetRevisionController() const = 0;
 
       virtual const ICollectionDataController* GetDataController() const = 0;
 
       virtual int GetOperationFlags(const Id& elementId = Id()) const = 0;
 
       virtual Id InsertNewObject(
                            const QByteArray& typeId,
                            const QString& name,
                            const QString& description,
                            const istd::IChangeable* defaultValuePtr = nullptr,
                            const Id& proposedElementId = Id(),
                            const idoc::IDocumentMetaInfo* dataMetaInfoPtr = nullptr,
                            const idoc::IDocumentMetaInfo* elementMetaInfoPtr = nullptr,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual bool RemoveElements(
                            const Ids& elementIds,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual bool RemoveElementSet(
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual bool RestoreObjects(
                            const Ids& objectIds,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual bool RestoreObjectSet(
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual const istd::IChangeable* GetObjectPtr(const Id& objectId) const = 0;
 
       template<typename Interface>
       const Interface* GetObjectPtr(const Id& objectId) const
       {
              return dynamic_cast<const Interface*>(GetObjectPtr(objectId));
       }
 
       virtual bool GetObjectData(const Id& objectId, DataPtr& dataPtr, const iprm::IParamsSet* dataConfigurationPtr = nullptr) const = 0;
 
       virtual bool SetObjectData(
                            const Id& objectId,
                            const istd::IChangeable& object,
                            CompatibilityMode mode = CM_WITHOUT_REFS,
                            const IOperationContext* operationContextPtr = nullptr) = 0;
 
       virtual istd::TUniqueInterfacePtr<IObjectCollection> CreateSubCollection(
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr) const = 0;
 
       virtual imtbase::IObjectCollectionIterator* CreateObjectCollectionIterator(
                            const QByteArray& objectId = QByteArray(),
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr) const = 0;
 
       virtual void ResetObjectIds();
};
 
 
// public inline methods
 
inline void IObjectCollection::ResetObjectIds()
{
       Q_ASSERT_X(false, "IObjectCollection::ResetObjectIds", "Method not implemented");
}
 
 
typedef istd::TUniqueInterfacePtr<IObjectCollection> IObjectCollectionUniquePtr;
typedef istd::TSharedInterfacePtr<IObjectCollection> IObjectCollectionSharedPtr;
 
 
} // namespace imtbase