Manager of file-based resources. More...

#include <IFileResourcesManager.h>

Inheritance diagram for ifile::IFileResourcesManager:

Public Types
enum	LicenseStatus { LS_NONE , LS_OK , LS_NOT_VALID }
	Status of the resource license. More...

typedef istd::TSharedInterfacePtr< istd::IChangeable >	DataObjectPtr

typedef QList< QByteArray >	Ids

typedef idoc::MetaInfoPtr	MetaInfoPtr

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual Ids	GetFileIds () const =0
	Get list of file/resource IDs in the repository.

virtual const IFileResourceTypeConstraints *	GetResourceTypeConstraints () const =0
	Get type contraints describing each supported type of a resource.

virtual QByteArray	GetResourceTypeId (const QByteArray &resourceId) const =0
	Get type ID if the resource.

virtual QByteArray	CreateNewFile (const QByteArray &fileTypeId, const istd::IChangeable *dataObjectPtr, const QString &filePath=QString(), const QString &resourceName=QString())=0
	Create new file resource.

virtual bool	RemoveFile (const QByteArray &fileId)=0
	Remove file from the resources storage.

virtual DataObjectPtr	GetDataObject (const QByteArray &fileId) const =0
	Get data object for the given resource.

virtual idoc::MetaInfoPtr	GetFileMetaInfo (const QByteArray &resourceId) const =0
	Get meta info of an existing file resource.

virtual QString	GetResourceName (const QByteArray &resourceId) const =0
	Get the name of the file resource in the storage.

virtual bool	SetResourceName (const QByteArray &resourceId, const QString &name)=0
	Set the name of the file resource in the storage.

virtual QString	GetResourceDescription (const QByteArray &resourceId) const =0
	Get the description of the file resource in the storage.

virtual bool	SetResourceDescription (const QByteArray &resourceId, const QString &description)=0
	Set the description of the file resource in the storage.

virtual LicenseStatus	GetLicenseStatus (const QByteArray &resourceId, const QByteArray &resourceTypeId=QByteArray(), ilog::IMessageConsumer *messageConsumerPtr=NULL) const =0
	Get the license status of the given resource.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Manager of file-based resources.

Definition at line 27 of file IFileResourcesManager.h.

Member Typedef Documentation

◆ DataObjectPtr

typedef istd::TSharedInterfacePtr<istd::IChangeable> ifile::IFileResourcesManager::DataObjectPtr

Definition at line 30 of file IFileResourcesManager.h.

◆ Ids

typedef QList<QByteArray> ifile::IFileResourcesManager::Ids

Definition at line 31 of file IFileResourcesManager.h.

◆ MetaInfoPtr

typedef idoc::MetaInfoPtr ifile::IFileResourcesManager::MetaInfoPtr

Definition at line 32 of file IFileResourcesManager.h.

Member Enumeration Documentation

◆ LicenseStatus

enum ifile::IFileResourcesManager::LicenseStatus

Status of the resource license.

Enumerator

LS_NONE

The resource is not licensed.

It means, the resource can be used and edited without any restrictions.

LS_OK

The resource is licensed and the user of the repository has all neccessary rights for using it.

LS_NOT_VALID

The resource is licensed, but the user of the repository has no valid licenses for using it.

Definition at line 37 of file IFileResourcesManager.h.

Member Function Documentation

◆ CreateNewFile()

virtual QByteArray ifile::IFileResourcesManager::CreateNewFile	(	const QByteArray &	fileTypeId,
		const istd::IChangeable *	dataObjectPtr,
		const QString &	filePath = `QString()`,
		const QString &	resourceName = `QString()`
	)

pure virtual

Create new file resource.

Parameters

ID	of the resource (file) type.
Initial	state of the data object. Can be `NULL`.
File	path of the new resource.
Name	(alias) of the resource.

Returns: ID of the created resource or an empty string if the operation failed.

◆ GetDataObject()

virtual DataObjectPtr ifile::IFileResourcesManager::GetDataObject ( const QByteArray & fileId ) const

pure virtual

Get data object for the given resource.

◆ GetFileIds()

virtual Ids ifile::IFileResourcesManager::GetFileIds ( ) const

pure virtual

Get list of file/resource IDs in the repository.

◆ GetFileMetaInfo()

virtual idoc::MetaInfoPtr ifile::IFileResourcesManager::GetFileMetaInfo ( const QByteArray & resourceId ) const

pure virtual

Get meta info of an existing file resource.

Parameters

resourceId ID of the file resource.

Returns: Pointer to the meta-info instance or NULL, if no information could be provided.

◆ GetLicenseStatus()

virtual LicenseStatus ifile::IFileResourcesManager::GetLicenseStatus	(	const QByteArray &	resourceId,
		const QByteArray &	resourceTypeId = `QByteArray()`,
		ilog::IMessageConsumer *	messageConsumerPtr = `NULL`
	)		const

pure virtual

Get the license status of the given resource.

See also: LicenseStatus

◆ GetResourceDescription()

virtual QString ifile::IFileResourcesManager::GetResourceDescription ( const QByteArray & resourceId ) const

pure virtual

Get the description of the file resource in the storage.

Parameters

resourceId ID of the file in the storage.

◆ GetResourceName()

virtual QString ifile::IFileResourcesManager::GetResourceName ( const QByteArray & resourceId ) const

pure virtual

Get the name of the file resource in the storage.

Parameters

resourceId ID of the file in the storage.

◆ GetResourceTypeConstraints()

virtual const IFileResourceTypeConstraints * ifile::IFileResourcesManager::GetResourceTypeConstraints ( ) const

pure virtual

Get type contraints describing each supported type of a resource.

Returns: Type constraints, if available or NULL, if no type constraints are known.

◆ GetResourceTypeId()

virtual QByteArray ifile::IFileResourcesManager::GetResourceTypeId ( const QByteArray & resourceId ) const

pure virtual

Get type ID if the resource.

\resourceId ID of the file resource in the storage.

Returns: Type ID of the resource or an empty string, if the resource was not found or the type is unknown.

◆ RemoveFile()

virtual bool ifile::IFileResourcesManager::RemoveFile ( const QByteArray & fileId )

pure virtual

Remove file from the resources storage.

Parameters

resourceId ID of the file to be removed.

◆ SetResourceDescription()

virtual bool ifile::IFileResourcesManager::SetResourceDescription	(	const QByteArray &	resourceId,
		const QString &	description
	)

pure virtual

Set the description of the file resource in the storage.

Parameters

resourceId	ID of the file in the storage.
description	Description of the file resource.

◆ SetResourceName()

virtual bool ifile::IFileResourcesManager::SetResourceName	(	const QByteArray &	resourceId,
		const QString &	name
	)

pure virtual

Set the name of the file resource in the storage.

Parameters

resourceId	ID of the file in the storage.
name	Name of the file resource.

The documentation for this class was generated from the following file:

Acf/Include/ifile/IFileResourcesManager.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DataObjectPtr

◆ Ids

◆ MetaInfoPtr

Member Enumeration Documentation

◆ LicenseStatus

Member Function Documentation

◆ CreateNewFile()

◆ GetDataObject()

◆ GetFileIds()

◆ GetFileMetaInfo()

◆ GetLicenseStatus()

◆ GetResourceDescription()

◆ GetResourceName()

◆ GetResourceTypeConstraints()

◆ GetResourceTypeId()

◆ RemoveFile()

◆ SetResourceDescription()

◆ SetResourceName()