imtrepo::IFileCollectionInfo

#include <IFileCollectionInfo.h>

Inheritance diagram for imtrepo::IFileCollectionInfo:

Public Types
enum	FileCollectionLayout { FCL_FLAT , FCL_FOLDER }

Public Member Functions
virtual const ifile::IFileResourceTypeConstraints *	GetFileTypeConstraints () const =0
virtual bool	GetFileInfo (const QByteArray &objectId, IFileCollectionItem &collectionItem) const =0
virtual FileCollectionLayout	GetCollectionFileLayout () const =0
virtual QString	GetCollectionRootFolder () const =0
virtual int	GetRepositoryRevision () const =0

Detailed Description

Interface for describing the structure of a file-based collection.

Definition at line 24 of file IFileCollectionInfo.h.

Member Enumeration Documentation

FileCollectionLayout

enum imtrepo::IFileCollectionInfo::FileCollectionLayout

Type of the repository layout.

Enumerator
FCL_FLAT	All repository files are placed in the same folder.
FCL_FOLDER	Each repository is placed in its own folder.

Definition at line 30 of file IFileCollectionInfo.h.

Member Function Documentation

GetCollectionFileLayout()

virtual FileCollectionLayout imtrepo::IFileCollectionInfo::GetCollectionFileLayout ( ) const

pure virtual

Get information about a type of the file collection layout.

GetCollectionRootFolder()

virtual QString imtrepo::IFileCollectionInfo::GetCollectionRootFolder ( ) const

pure virtual

Get path to the root folder of the file collection.

GetFileInfo()

virtual bool imtrepo::IFileCollectionInfo::GetFileInfo ( const QByteArray &  objectId, IFileCollectionItem &  collectionItem  ) const

pure virtual

Get file information related to a object

Parameters

objectId

ID of the file in the collection

Returns

Related informations

See also

FileInfo

GetFileTypeConstraints()

virtual const ifile::IFileResourceTypeConstraints * imtrepo::IFileCollectionInfo::GetFileTypeConstraints ( ) const

pure virtual

Get type contraints describing each supported type of a resource.

Returns

Type constraints, if available or nullptr, if no type constraints were defined.

GetRepositoryRevision()

virtual int imtrepo::IFileCollectionInfo::GetRepositoryRevision ( ) const

pure virtual

Get repository revision.