document_state.h

Go to the documentation of this file.

#ifndef UPE_CORE_API_DOCUMENT_STATE_H_
#define UPE_CORE_API_DOCUMENT_STATE_H_
 
#include <chrono>
#include <map>
#include <memory>
#include <utility>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/mip_namespace.h"
#include "mip/protection_descriptor.h"
#include "mip/upe/classification_request.h"
#include "mip/upe/classification_result.h"
#include "mip/upe/metadata_entry.h"
#include "mip/upe/metadata_version.h"
 
MIP_NAMESPACE_BEGIN
 
class DocumentState {
public:
  virtual std::string GetContentIdentifier() const = 0;
 
  virtual DataState GetDataState() const { return DataState::USE; };
 
  virtual std::vector<MetadataEntry> GetContentMetadata(
      const std::vector<std::string>& names, const std::vector<std::string>& namePrefixes) const = 0;
  
  virtual std::shared_ptr<ProtectionDescriptor> GetProtectionDescriptor() const = 0;
 
  virtual std::string GetContentFormat() const = 0;
  
  virtual MetadataVersion GetContentMetadataVersion() const {
    return MetadataVersion(0, MetadataVersionFormat::DEFAULT);
  };
  
  virtual std::shared_ptr<ClassificationResults> GetClassificationResults(
      const std::vector<std::shared_ptr<ClassificationRequest>>& /*classificationIds*/) const {
    return nullptr;
  }
 
  virtual std::map<std::string, std::string> GetAuditMetadata() const { return std::map<std::string, std::string>(); }
 
  virtual std::chrono::time_point<std::chrono::system_clock> GetLastModifiedTime() const { return std::chrono::time_point<std::chrono::system_clock>(); };
 
  virtual ~DocumentState() {}
 
protected:
  DocumentState() {}
};
 
MIP_NAMESPACE_END
#endif  // UPE_CORE_API_DOCUMENT_STATE_H_