imtbase::IReferenceCollection

#include <IReferenceCollection.h>

Inheritance diagram for imtbase::IReferenceCollection:

Public Member Functions
virtual bool	InsertReference (const Id &objectId, const QByteArray &repositoryId=QByteArray())=0
virtual bool	RemoveReference (const Id &objectId)=0
virtual bool	RemoveAllReferences ()=0
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::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 collection of references to the objects that can be identified (e.g. in some abstract storage) using their IDs.

Definition at line 21 of file IReferenceCollection.h.

Member Function Documentation

InsertReference()

virtual bool imtbase::IReferenceCollection::InsertReference ( const Id &  objectId, const QByteArray &  repositoryId = QByteArray()  )

pure virtual

Insert a new reference into the collection.

Parameters

objectId	unique ID of the object in the related repository to be referenced
repositoryId	Repository identifier

RemoveAllReferences()

virtual bool imtbase::IReferenceCollection::RemoveAllReferences ( )

pure virtual

Remove all references from the collection.

RemoveReference()

virtual bool imtbase::IReferenceCollection::RemoveReference ( const Id &  objectId )

pure virtual

Remove a given reference from the collection.