imtbase::ICollectionInfo

#include <ICollectionInfo.h>

Inheritance diagram for imtbase::ICollectionInfo:

Public Types
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 }

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

Detailed Description

Interface for non-iterable colllection info.

Definition at line 26 of file ICollectionInfo.h.

Member Enumeration Documentation

ChangeFlags

enum imtbase::ICollectionInfo::ChangeFlags

Change notification flags.

Enumerator
CF_ADDED	Element was added.
CF_ELEMENT_RENAMED	Element was renamed.
CF_ELEMENT_DESCRIPTION_CHANGED	Element was renamed.
CF_ELEMENT_STATE	Element was enabled/disabled.
CF_REMOVED	Element was removed.
CF_RESTORED	Element was restored.

Definition at line 65 of file ICollectionInfo.h.

ElementInfoType

enum imtbase::ICollectionInfo::ElementInfoType

Type of the element information.

Enumerator
EIT_NAME	Name of the element given as a QString.
EIT_DESCRIPTION	Human-readable description of the element given as a QString.
EIT_ENABLED	Enabled/Disabled status of the element as a boolean.
EIT_USER	Start value for user-defined info types.

Definition at line 103 of file ICollectionInfo.h.

MetaInfoType

enum imtbase::ICollectionInfo::MetaInfoType

Type of the meta-informations supported by the collection.

Enumerator
MIT_INSERTION_USER	Name of the user who has added the element.
MIT_INSERTION_TIME	Timestamp of the element inserting into the collection.
MIT_LAST_OPERATION_USER	Name of the user who has modified the element.
MIT_LAST_OPERATION_TIME	Timestamp of the last operation on the element in the collection.
MIT_PREVIEW_THUMBNAIL	Tumbnail for the item preview.
MIT_REVISION	Current element revision.

Definition at line 129 of file ICollectionInfo.h.

Member Function Documentation

GetElementIds()

virtual Ids imtbase::ICollectionInfo::GetElementIds ( int  offset = 0, int  count = -1, const iprm::IParamsSet *  selectionParamsPtr = nullptr, ilog::IMessageConsumer *  logPtr = nullptr  ) const

pure virtual

Get IDs of the elements inside the collection for parent.

Parameters

offset	[optional] Index offset of the first element
count	[optional] If positive, the number of elements should be returned.
selectionParamsPtr	[optional] Additional parameters for filtering/ordering elements.
parentId	[optional] Parent element ID. Entire filtering operation applies to the childs of this element only.

GetElementInfo()

virtual QVariant imtbase::ICollectionInfo::GetElementInfo ( const Id &  elementId, int  infoType, ilog::IMessageConsumer *  logPtr = nullptr  ) const

pure virtual

Get information about a given element.

GetElementMetaInfo()

virtual idoc::MetaInfoPtr imtbase::ICollectionInfo::GetElementMetaInfo ( const Id &  elementId, ilog::IMessageConsumer *  logPtr = nullptr  ) const

pure virtual

Get meta-information of the element in the collection.

Parameters

elementId	ID of the element in the collection.
metaInfo	Meta-info to be filled by this method.

Returns

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

GetElementsCount()

virtual int imtbase::ICollectionInfo::GetElementsCount ( const iprm::IParamsSet *  selectionParamsPtr = nullptr, ilog::IMessageConsumer *  logPtr = nullptr  ) const

pure virtual

Get number of elements in the collection

GetSubsetInfo()

virtual bool imtbase::ICollectionInfo::GetSubsetInfo ( ICollectionInfo &  subsetInfo, int  offset = 0, int  count = -1, const iprm::IParamsSet *  selectionParamsPtr = nullptr, ilog::IMessageConsumer *  logPtr = nullptr  ) const

pure virtual

Get information about the subset of the whole collection according to the given filtering/sorting parameters.

Parameters

subsetInfo	collection information for the data subset.
offset	[optional] Index offset of the first element
count	[optional] If positive, the number of elements should be returned.
selectionParamsPtr	[optional] Additional parameters for filtering/ordering elements.
parentId	[optional] Parent element ID. Entire filtering operation applies to the childs of this element only.

SetElementDescription()

virtual bool imtbase::ICollectionInfo::SetElementDescription ( const Id &  elementId, const QString &  description, ilog::IMessageConsumer *  logPtr = nullptr  )

pure virtual

Set description of the element with the given ID.

SetElementEnabled()

virtual bool imtbase::ICollectionInfo::SetElementEnabled ( const Id &  elementId, bool  isEnabled = true, ilog::IMessageConsumer *  logPtr = nullptr  )

pure virtual

Enable/Disable element with the given ID.

SetElementName()

virtual bool imtbase::ICollectionInfo::SetElementName ( const Id &  elementId, const QString &  name, ilog::IMessageConsumer *  logPtr = nullptr  )

pure virtual

Set name of the element with the given ID.