IFileResourcesManager.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QList>
 
// ACF includes
#include <istd/TSmartPtr.h>
#include <ilog/IMessageConsumer.h>
#include <iprm/IOptionsList.h>
#include <idoc/IDocumentMetaInfo.h>
#include <ifile/IFileMetaInfoProvider.h>
 
 
namespace ifile
{
 
 
class IFileResourceTypeConstraints;
 
 
class IFileResourcesManager: virtual public istd::IChangeable
{
public:
       typedef istd::TSharedInterfacePtr<istd::IChangeable> DataObjectPtr;
       typedef QList<QByteArray> Ids;
       typedef idoc::MetaInfoPtr MetaInfoPtr;
 
       enum LicenseStatus
       {
              LS_NONE,
 
              LS_OK,
 
              LS_NOT_VALID
       };
 
 
       virtual Ids GetFileIds() const = 0;
 
       virtual const IFileResourceTypeConstraints* GetResourceTypeConstraints() const = 0;
 
       virtual QByteArray GetResourceTypeId(const QByteArray& resourceId) const = 0;
 
       virtual QByteArray CreateNewFile(
                            const QByteArray& fileTypeId,
                            const istd::IChangeable* dataObjectPtr,
                            const QString& filePath = QString(),
                            const QString& resourceName = QString()) = 0;
 
       virtual bool RemoveFile(const QByteArray& fileId) = 0;
 
       virtual DataObjectPtr GetDataObject(const QByteArray& fileId) const = 0;
 
       virtual idoc::MetaInfoPtr GetFileMetaInfo(const QByteArray& resourceId) const = 0;
 
       virtual QString GetResourceName(const QByteArray& resourceId)  const = 0;
 
       virtual bool SetResourceName(const QByteArray& resourceId, const QString& name) = 0;
 
       virtual QString GetResourceDescription(const QByteArray& resourceId)  const = 0;
 
       virtual bool SetResourceDescription(const QByteArray& resourceId, const QString& description) = 0;
 
       virtual LicenseStatus GetLicenseStatus(
                            const QByteArray& resourceId,
                            const QByteArray& resourceTypeId = QByteArray(),
                            ilog::IMessageConsumer* messageConsumerPtr = NULL) const = 0;
};
 
 
} // namespace ifile