Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
LabelingOptions Class Reference

Interface for configuring labeling options for the SetLabel/DeleteLabel methods. More...

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

Public Member Functions

AssignmentMethod GetAssignmentMethod () const
 
const std::vector< std::pair< std::string, std::string > > & GetExtendedProperties () const
 
const std::string & GetJustificationMessage () const
 
bool IsDowngradeJustified () const
 
 LabelingOptions (AssignmentMethod method)
 
void SetDowngradeJustification (bool isDowngradeJustified, const std::string &justificationMessage)
 
void SetExtendedProperties (const std::vector< std::pair< std::string, std::string > > &extendedProperties)
 

Detailed Description

Interface for configuring labeling options for the SetLabel/DeleteLabel methods.

Definition at line 42 of file labeling_options.h.

Constructor & Destructor Documentation

◆ LabelingOptions()

LabelingOptions::LabelingOptions ( AssignmentMethod method)
inline

Definition at line 45 of file labeling_options.h.

46 : mAssignmentMethod(method),
47 mIsDowngradeJustified(false) {
48 }

Member Function Documentation

◆ GetAssignmentMethod()

AssignmentMethod LabelingOptions::GetAssignmentMethod ( ) const
inline

Definition at line 50 of file labeling_options.h.

50 {
51 return mAssignmentMethod;
52 }

◆ GetExtendedProperties()

const std::vector< std::pair< std::string, std::string > > & LabelingOptions::GetExtendedProperties ( ) const
inline

Definition at line 62 of file labeling_options.h.

62 {
63 return mExtendedProperties;
64 }

◆ GetJustificationMessage()

const std::string & LabelingOptions::GetJustificationMessage ( ) const
inline

Definition at line 58 of file labeling_options.h.

58 {
59 return mJustificationMessage;
60 }

◆ IsDowngradeJustified()

bool LabelingOptions::IsDowngradeJustified ( ) const
inline

Definition at line 54 of file labeling_options.h.

54 {
55 return mIsDowngradeJustified;
56 }

◆ SetDowngradeJustification()

void LabelingOptions::SetDowngradeJustification ( bool isDowngradeJustified,
const std::string & justificationMessage )
inline

Definition at line 66 of file labeling_options.h.

66 {
67 mIsDowngradeJustified = isDowngradeJustified;
68 mJustificationMessage = justificationMessage;
69 }

◆ SetExtendedProperties()

void LabelingOptions::SetExtendedProperties ( const std::vector< std::pair< std::string, std::string > > & extendedProperties)
inline

Definition at line 71 of file labeling_options.h.

71 {
72 mExtendedProperties = extendedProperties;
73 }

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