imtbase::IObjectCollectionInfo

#include <IObjectCollectionInfo.h>

Inheritance diagram for imtbase::IObjectCollectionInfo:

Public Member Functions
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::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

Interface for getting information about a collection of data objects.

Definition at line 23 of file IObjectCollectionInfo.h.

Member Function Documentation

GetDataMetaInfo()

virtual idoc::MetaInfoPtr imtbase::IObjectCollectionInfo::GetDataMetaInfo ( const Id &  objectId ) const

pure virtual

Get meta-information of the data object. In difference to GetCollectionItemMetaInfo, this method get the meta-informations related to the data itself.

Parameters

objectId

ID of the object in the collection.

Returns

true if the operation was successful, and false if no information could be provided.

GetObjectTypeId()

virtual Id imtbase::IObjectCollectionInfo::GetObjectTypeId ( const Id &  objectId ) const

pure virtual

Get the type-ID of the object.

GetObjectTypesInfo()

virtual const iprm::IOptionsList * imtbase::IObjectCollectionInfo::GetObjectTypesInfo ( ) const

pure virtual

Get the list of the available object types.