DocumentState Class Reference

#include <mip/upe/core/document_state.h>

Public Member Functions
virtual std::string	GetContentIdentifier () const =0
	Gets the content description that describes the document. example for a file: [path\filename] example for an email: [Subject:Sender].
virtual DataState	GetDataState () const
	Gets the state of the content while the application is interacting with it.
virtual std::vector< MetadataEntry >	GetContentMetadata (const std::vector< std::string > &names, const std::vector< std::string > &namePrefixes) const =0
	Get the meta-data items from the content.
virtual std::shared_ptr< ProtectionDescriptor >	GetProtectionDescriptor () const =0
	Get the Protection Descriptor.
virtual std::string	GetContentFormat () const =0
	Gets the content format.
virtual MetadataVersion	GetContentMetadataVersion () const
	Gets the highest metadata version supported by the application for the tenant.
virtual std::shared_ptr< ClassificationResults >	GetClassificationResults (const std::vector< std::shared_ptr< ClassificationRequest > > &) const
	Return a map of classification results.
virtual std::map< std::string, std::string >	GetAuditMetadata () const
	Return a map of application specific audit key-value pairs.
virtual std::chrono::time_point< std::chrono::system_clock >	GetLastModifiedTime () const
	Return a time point to the last time the document was modified.
virtual	~DocumentState ()

Protected Member Functions
	DocumentState ()

Constructor & Destructor Documentation

~DocumentState()

virtual DocumentState::~DocumentState ( )

inlinevirtual

DocumentState()

DocumentState::DocumentState ( )

inlineprotected

Member Function Documentation

GetAuditMetadata()

virtual std::map< std::string, std::string > DocumentState::GetAuditMetadata ( ) const

inlinevirtual

Return a map of application specific audit key-value pairs.

Returns

a list of application specific audit metadata

Note

Registered Key:Value pairs Sender: Email Id for the sender Recipients: Represents a JSON array of recipients for an email LastModifiedBy: Email Id for the user who last modified the content LastModifiedDate: Date the content was last modified

GetClassificationResults()

virtual std::shared_ptr< ClassificationResults > DocumentState::GetClassificationResults ( const std::vector< std::shared_ptr< ClassificationRequest > > & ) const

inlinevirtual

Return a map of classification results.

Parameters

classificationIds

a list of classification IDs.

Returns

a list of classification results.

Note

return nullptr if no classification cycle executed.

GetContentFormat()

virtual std::string DocumentState::GetContentFormat ( ) const

pure virtual

Gets the content format.

Returns

content format

GetContentIdentifier()

virtual std::string DocumentState::GetContentIdentifier ( ) const

pure virtual

Gets the content description that describes the document. example for a file: [path\filename] example for an email: [Subject:Sender].

Returns

content description to be applied to the content.

Note

This value is used by auditing as a human-readable description of the content

GetContentMetadata()

virtual std::vector< MetadataEntry > DocumentState::GetContentMetadata ( const std::vector< std::string > & names, const std::vector< std::string > & namePrefixes ) const

pure virtual

Get the meta-data items from the content.

Returns

the metadata applied to the content.

See also

mip::MetadataEntry.

GetContentMetadataVersion()

virtual MetadataVersion DocumentState::GetContentMetadataVersion ( ) const

inlinevirtual

Gets the highest metadata version supported by the application for the tenant.

Returns

Content metadata version. If 0, metadata is un-versioned.

Note

If a file format supports multiple versions of metadata, this allows MIP to understand all metadata and report granular metadata changes on a per-version basis.

GetDataState()

virtual DataState DocumentState::GetDataState ( ) const

inlinevirtual

Gets the state of the content while the application is interacting with it.

Returns

State of the content data

GetLastModifiedTime()

virtual std::chrono::time_point< std::chrono::system_clock > DocumentState::GetLastModifiedTime ( ) const

inlinevirtual

Return a time point to the last time the document was modified.

Returns

the last modified time of the documents time point.

GetProtectionDescriptor()

virtual std::shared_ptr< ProtectionDescriptor > DocumentState::GetProtectionDescriptor ( ) const

pure virtual

Get the Protection Descriptor.

Returns

the Protection Descriptor

---

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

• src/api/mip/upe/core/document_state.h