FileExecutionState Class Reference

#include <src/api/mip/file/file_execution_state.h>

Public Member Functions
virtual const std::string	GetApplicationScenarioId () const
	Return an identifier which correlates application events with the corresponding protection service REST requests.
virtual std::map< std::string, std::string >	GetAuditMetadata () const
	Return a map of application specific audit key-value pairs.
virtual std::shared_ptr< ClassificationResults >	GetClassificationResults (const std::shared_ptr< FileHandler > &, const std::vector< std::shared_ptr< ClassificationRequest > > &) const
	Return a map of classification results.
virtual DataState	GetDataState () const
	Gets the state of the content while the application is interacting with it.

Detailed Description

Definition at line 44 of file file_execution_state.h.

Member Function Documentation

GetApplicationScenarioId()

virtual const std::string FileExecutionState::GetApplicationScenarioId ( ) const

inlinevirtual

Return an identifier which correlates application events with the corresponding protection service REST requests.

Returns

An identifier (usually specified as a GUID)

Definition at line 87 of file file_execution_state.h.

                                                           {
    return std::string();
  }

GetAuditMetadata()

virtual std::map< std::string, std::string > FileExecutionState::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

Definition at line 78 of file file_execution_state.h.

                                                                { 
    return std::map<std::string, std::string>(); 
  }

GetClassificationResults()

virtual std::shared_ptr< ClassificationResults > FileExecutionState::GetClassificationResults ( const std::shared_ptr< FileHandler > & , const std::vector< std::shared_ptr< ClassificationRequest > > &  ) const

inlinevirtual

Return a map of classification results.

Parameters

fileHandler	- the file handler of the used file
classificationIds	a list of classification IDs.

Returns

a list of classification results.

Definition at line 61 of file file_execution_state.h.

                                                                      {
    return nullptr;
  }

GetDataState()

virtual DataState FileExecutionState::GetDataState ( ) const

inlinevirtual

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

Returns

State of the content data

Definition at line 51 of file file_execution_state.h.

                                         {
    return DataState::REST;
  }

References REST.

---

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

• src/api/mip/file/file_execution_state.h