IGqlObjectCollectionDelegate.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 <idoc/IDocumentMetaInfo.h>
 
// ImtCore includes
#include <imtbase/IMetaInfoCreator.h>
#include <imtbase/IOperationContext.h>
#include <imtbase/IObjectCollection.h>
#include <imtgql/IGqlResponse.h>
 
 
namespace imtclientgql
{
 
 
class IGqlObjectCollectionDelegate: virtual public istd::IPolymorphic
{
public:
       typedef QByteArray Id;
       typedef QByteArrayList Ids;
 
       struct ObjectInfo
       {
              ObjectInfo()
                     :version(-1)
              {
              }
 
              QByteArray id;
              QString name;
              QString description;
              QByteArray typeId;
 
              QSharedPointer<idoc::IDocumentMetaInfo> dataMetaInfoPtr;
 
              int version;
       };
       typedef QList<ObjectInfo> ObjectInfoList;
 
       virtual imtgql::IGqlRequest* CreateGetObjectTypeIdRequest(const QByteArray& objectId) const = 0;
       virtual imtgql::IGqlRequest* CreateGetObjectInfoRequest(const QByteArray& objectId) const = 0;
       virtual imtgql::IGqlRequest* CreateGetObjectMetaInfoRequest(const QByteArray& objectId) const = 0;
       virtual imtgql::IGqlRequest* CreateGetObjectDataMetaInfoRequest(const QByteArray& objectId) const = 0;
       virtual imtgql::IGqlRequest* CreateInsertObjectRequest(
                            const QByteArray& typeId,
                            const QString& name,
                            const QString& description,
                            const istd::IChangeable* objectPtr,
                            const QString& uploadUrl = QString(),
                            const QByteArray& proposedObjectId = QByteArray(),
                            const QByteArray& nodeId = QByteArray(),
                            const idoc::IDocumentMetaInfo* dataMetaInfoPtr = nullptr,
                            const idoc::IDocumentMetaInfo* collectionItemMetaInfoPtr = nullptr,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateSetObjectNameRequest(
                            const QByteArray& objectId,
                            const QString& name,
                            int clientVersion = -1,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateSetObjectDescriptionRequest(
                            const QByteArray& objectId,
                            const QString& description,
                            int clientVersion = -1,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateGetObjectRequest(const QByteArray& objectId, const iprm::IParamsSet* paramsPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateSetObjectRequest(
                            const QByteArray& objectId,
                            const QByteArray& typeId,
                            const istd::IChangeable* objectPtr,
                            const QString& uploadUrl = QString(),
                            const idoc::IDocumentMetaInfo* dataMetaInfoPtr = nullptr,
                            const idoc::IDocumentMetaInfo* collectionItemMetaInfoPtr = nullptr,
                            int clientVersion = -1,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateRemoveObjectsRequest(
                            const imtbase::ICollectionInfo::Ids& objectIds,
                            int clientElementVersion = -1,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateRemoveObjectSetRequest(
                            const iprm::IParamsSet* selectionParamsPtr = nullptr,
                            int clientElementVersion = -1,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateGetElementCountRequest(
                            const iprm::IParamsSet* selectionParamsPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateGetElementListRequest(
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr) const = 0;
       virtual imtgql::IGqlRequest* CreateGetSubCollectionRequest(
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* selectionParamsPtr = nullptr) const = 0;
 
       virtual bool IsValid(const imtgql::IGqlResponse& response) const = 0;
       virtual bool GetOperationResult(const imtgql::IGqlResponse& response, bool& out) const = 0;
       virtual bool GetObjectId(const imtgql::IGqlResponse& response, Id& out) const = 0;
       virtual bool GetObjectTypeId(const imtgql::IGqlResponse& response, Id& out) const = 0;
       virtual bool GetObjectInfo(const imtgql::IGqlResponse& response, ObjectInfo& out) const = 0;
       virtual bool GetObjectData(const imtgql::IGqlResponse& response, istd::IChangeable& out) const = 0;
       virtual bool GetMetaInfo(const imtgql::IGqlResponse& response, idoc::IDocumentMetaInfo& out) const = 0;
       virtual bool GetItemCount(const imtgql::IGqlResponse& response, int& out) const = 0;
       virtual bool GetItemIds(const imtgql::IGqlResponse& response, Ids& out) const = 0;
       virtual imtbase::IObjectCollection* GetSubCollection(
                            imtbase::IObjectCollection& collection,
                            const imtgql::IGqlResponse& response,
                            QList<imtbase::IMetaInfoCreator*> metaInfoCreatorList) const = 0;
};
 
 
} // namespace imtclientgql