mitkIPropertyPersistence.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef mitkIPropertyPersistence_h
#define mitkIPropertyPersistence_h

#include <mitkPropertyPersistenceInfo.h>
#include <mitkServiceInterface.h>

namespace mitk
{
  class MITKCORE_EXPORT IPropertyPersistence
  {
  public:
    virtual ~IPropertyPersistence();

    using InfoResultType = std::list<PropertyPersistenceInfo::ConstPointer>;
    using MimeTypeNameType = PropertyPersistenceInfo::MimeTypeNameType;

    virtual bool AddInfo(const PropertyPersistenceInfo *info, bool overwrite = false) = 0;

    virtual InfoResultType GetInfo(const std::string &propertyName, bool allowNameRegEx = true) const = 0;

    virtual InfoResultType GetInfo(const std::string &propertyName,
                                   const MimeTypeNameType &mime,
                                   bool allowMimeWildCard = false,
                                   bool allowNameRegEx = true) const = 0;

    virtual InfoResultType GetInfoByKey(const std::string &persistenceKey, bool allowKeyRegEx = true) const = 0;

    virtual bool HasInfo(const std::string &propertyName, bool allowNameRegEx = true) const = 0;

    virtual void RemoveAllInfo() = 0;

    virtual void RemoveInfo(const std::string &propertyName) = 0;

    virtual void RemoveInfo(const std::string &propertyName, const MimeTypeNameType &mime) = 0;
  };
}

MITK_DECLARE_SERVICE_INTERFACE(mitk::IPropertyPersistence, "org.mitk.IPropertyPersistence")

#endif