ImagingTools Core SDK
Public Member Functions | List of all members
imthype::ITaskCollectionabstract

#include <ITaskCollection.h>

Inheritance diagram for imthype::ITaskCollection:
imtbase::IObjectCollection imtbase::IObjectCollectionInfo imtbase::ICollectionInfo imthype::CTaskCollectionCompBase imthype::CTaskCollectionComp

Public Member Functions

virtual QByteArray GetUserTaskId (const QByteArray &taskUuid) const =0
 
virtual bool SetUserTaskId (const QByteArray &taskUuid, const QByteArray &userTaskId)=0
 
virtual QByteArray GetTaskInputId (const QByteArray &taskUuid) const =0
 
virtual bool SetTaskInputId (const QByteArray &taskUuid, const QByteArray &inputId)=0
 
virtual const iinsp::ISupplier * GetTask (const QByteArray &taskId) const =0
 
virtual const ITaskResultCollection * GetTaskResults (const QByteArray &taskId) const =0
 
virtual const imtbase::IObjectCollection * GetTaskInputs () const =0
 
- Public Member Functions inherited from imtbase::IObjectCollection
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
 
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 Member Functions inherited from imtbase::IObjectCollectionInfo
virtual const iprm::IOptionsList * GetObjectTypesInfo () const =0
 
virtual Id GetObjectTypeId (const Id &objectId) const =0
 
virtual idoc::MetaInfoPtr GetDataMetaInfo (const Id &objectId) const =0
 
- Public Member Functions inherited from imtbase::ICollectionInfo
virtual int GetElementsCount (const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
 
virtual Ids GetElementIds (int offset=0, int count=-1, const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
 
virtual bool GetSubsetInfo (ICollectionInfo &subsetInfo, int offset=0, int count=-1, const iprm::IParamsSet *selectionParamsPtr=nullptr, ilog::IMessageConsumer *logPtr=nullptr) const =0
 
virtual QVariant GetElementInfo (const Id &elementId, int infoType, ilog::IMessageConsumer *logPtr=nullptr) const =0
 
virtual idoc::MetaInfoPtr GetElementMetaInfo (const Id &elementId, ilog::IMessageConsumer *logPtr=nullptr) const =0
 
virtual bool SetElementName (const Id &elementId, const QString &name, ilog::IMessageConsumer *logPtr=nullptr)=0
 
virtual bool SetElementDescription (const Id &elementId, const QString &description, ilog::IMessageConsumer *logPtr=nullptr)=0
 
virtual bool SetElementEnabled (const Id &elementId, bool isEnabled=true, ilog::IMessageConsumer *logPtr=nullptr)=0
 

Additional Inherited Members

- Public Types inherited from imtbase::IObjectCollection
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
}
 
- Public Types inherited from imtbase::ICollectionInfo
enum  ChangeFlags {
  CF_ADDED = 10000 , CF_ELEMENT_RENAMED , CF_ELEMENT_DESCRIPTION_CHANGED , CF_ELEMENT_STATE ,
  CF_REMOVED , CF_RESTORED , CF_LAST
}
 
enum  ElementInfoType { EIT_NAME , EIT_DESCRIPTION , EIT_ENABLED , EIT_USER = 1000 }
 
enum  MetaInfoType {
  MIT_INSERTION_USER = idoc::IDocumentMetaInfo::MIT_USER + 10000 , MIT_INSERTION_TIME , MIT_LAST_OPERATION_USER , MIT_LAST_OPERATION_TIME ,
  MIT_PREVIEW_THUMBNAIL , MIT_REVISION = idoc::IDocumentMetaInfo::MIT_USER + 20000
}
 

Detailed Description

Common interface for a task collection. Please note that this is just the container of the tasks without any business logic about how these tasks should be performed.

Definition at line 23 of file ITaskCollection.h.

Member Function Documentation

◆ GetTask()

virtual const iinsp::ISupplier * imthype::ITaskCollection::GetTask ( const QByteArray &  taskId) const
pure virtual

Get access to the task instance.

Parameters
taskIdUnique ID of the task.

◆ GetTaskInputId()

virtual QByteArray imthype::ITaskCollection::GetTaskInputId ( const QByteArray &  taskUuid) const
pure virtual

Get ID of the input data for a given task. The input-ID is an identifier for getting the data related to the task from some external storage or abstract data provider.

◆ GetTaskInputs()

virtual const imtbase::IObjectCollection * imthype::ITaskCollection::GetTaskInputs ( ) const
pure virtual

Get available task inputs.

◆ GetTaskResults()

virtual const ITaskResultCollection * imthype::ITaskCollection::GetTaskResults ( const QByteArray &  taskId) const
pure virtual

Get the result data objects of the given task.

◆ GetUserTaskId()

virtual QByteArray imthype::ITaskCollection::GetUserTaskId ( const QByteArray &  taskUuid) const
pure virtual

Get the user-defined ID of the task.

◆ SetTaskInputId()

virtual bool imthype::ITaskCollection::SetTaskInputId ( const QByteArray &  taskUuid,
const QByteArray &  inputId 
)
pure virtual

Set ID of the input data for a given task.

◆ SetUserTaskId()

virtual bool imthype::ITaskCollection::SetUserTaskId ( const QByteArray &  taskUuid,
const QByteArray &  userTaskId 
)
pure virtual

Set the user-defined ID for a given task. The user-defined task-ID can be used related to some external controller system for the task execution. For example, an external system defines a task with the ID "FirstTask" and we want to connect it to a given task in the task collection. Then we use SetUserTaskId(TASK_UUID, "FirstTask") to create this binding. The task execution controller should find the task according to the user-defined task-ID and execute it.

Generated by doxygen 1.9.8