Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.ClassifiedSecurity Class Reference

The ClassifiedSecurity class is used when implementing the US DoD Classified Security standard. It is necessary to manage all updates to a Record's Security Classification using this class, rather than the TrimSecurityProfile class, to comply with the US DoD standard. Classified Security extends a normal security by classification by scheduling declassification and downgrading events More...

Inheritance diagram for HP.HPTRIM.SDK.ClassifiedSecurity:
HP.HPTRIM.SDK.TrimSDKObject

Public Member Functions

void SetInitialData (string primordialSecurity, TrimSecurityProfile sec, string reason, string derivedFromOther, string ClassifiedBy, TrimDateTime atTime, string classifyingAgency, SecurityGuideList DerivedFromSecurityGuideEntries)
 Set initial security classification of this record. More...
 
void SetDeclassifyData (RecordDeclassifyTypes declassifyType, int declassifyYears, TrimDateTime declassifyDate, string declassifyText, string declassifyInstructions)
 Set schedule for declassification of this record. More...
 
void SetDowngradeData (RecordDeclassifyTypes downgradeType, int downgradeYears, TrimDateTime downgradeDate, string downgradeText, string downgradeInstructions)
 Set schedule for downgrading the classification of this record. More...
 
void ModifySecurity (TrimSecurityProfile newSec, string reason, Location loc, TrimDateTime atTime)
 Modify the security classification of this record. More...
 
void SetReviewed (Location loc, TrimDateTime atTime)
 Set details of a classification review for this record. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
 TrimSDKObject ()
 

Properties

string PrimordialSecurity [get]
 Gets a string describing the security classification of this record prior to it entering the TRIM system. More...
 
SecurityLevel InitialSecurityLevel [get]
 Gets the initial security classification of this record (before any declassification or downgrade activity has been undertaken). More...
 
string ReasonForClassification [get]
 Gets a string describing the reason for the initial security classification of this record. More...
 
string ClassifiedBy [get]
 Gets a string describing the person responsible for the initial security classification. More...
 
string ClassifyingAgency [get]
 Gets a string describing the agency responsible for the initial security classification. More...
 
TrimDateTime ClassifiedOn [get]
 Gets a string describing the date that the security classification of the record was made. More...
 
string DerivedFrom [get]
 Gets a string describing the which authority or reference was used in determining the security classification of the record. More...
 
SecurityGuideList DerivedFromGuideEntries [get]
 Gets a array of security guide entries used in determining the security classification of the record. More...
 
TrimDateTime ScheduledDeclassificationDate [get]
 Gets a date that is calculated to be the date when this record should be declassified. More...
 
RecordDeclassifyTypes DeclassifyType [get]
 Gets a RecordDeclassifyTypes enum value indicating what type of process is to be used for determining the record declassification date. More...
 
int DeclassifyYears [get]
 Gets a number indicating the number of years the record classification should be kept (if DeclassifyType is based on a number of years). More...
 
TrimDateTime DeclassifyDate [get]
 Gets a date indicate a specific date for declassification of the record (if DeclassifyType is based on a specific date). More...
 
string DeclassifyText [get]
 Gets a string describing the event that should cause declassification (if DeclassifyType is based on an event occurring). More...
 
string DeclassifyInstructions [get]
 Gets a string describing how the actual declassification of the record should be undertaken. More...
 
TrimDateTime ScheduledDowngradeDate [get]
 Gets a date that is calculated to be the date when the security classification of the record should be downgraded. More...
 
RecordDeclassifyTypes DowngradeType [get]
 Gets a RecordDeclassifyTypes enum value indicating what type of process is to be used for determining when the record security classification should be downgraded. More...
 
int DowngradeYears [get]
 Gets a number indicating the number of years the record security classification should be kept prior to being downgraded (if DowngradeType is based on a number of years). More...
 
TrimDateTime DowngradeDate [get]
 Gets a date indicate a specific date for downgrade of the security classification of the record (if DowngradeType is based on a specific date). More...
 
string DowngradeText [get]
 Gets a string describing the event that should cause a downgrade of the security classification of the record (if DowngradeType is based on an event occurring). More...
 
string DowngradeInstructions [get]
 Gets a string describing how the actual downgrading of the security classification of the record should be undertaken. More...
 
TrimDateTime LastUpdatedOn [get]
 Gets a date and time indicating when the security classification was last modified. More...
 
Location LastUpdatedBy [get]
 Gets the location responsible for the most recent change to the security classification. More...
 
string LastUpdatedReason [get]
 Gets a string describing the reason for the most recent change to the security classification. More...
 
string LastUpdatedDescription [get]
 Gets a string describing the the most recent change that was made to the security classification. More...
 
TrimDateTime LastReviewedOn [get]
 Gets a date and time indicating when the security classification was most recently reviewed. More...
 
Location LastReviewedBy [get]
 Gets the location responsible for the most recent review of the security classification. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimSDKObject
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 

Detailed Description

The ClassifiedSecurity class is used when implementing the US DoD Classified Security standard. It is necessary to manage all updates to a Record's Security Classification using this class, rather than the TrimSecurityProfile class, to comply with the US DoD standard. Classified Security extends a normal security by classification by scheduling declassification and downgrading events

Member Function Documentation

void HP.HPTRIM.SDK.ClassifiedSecurity.ModifySecurity ( TrimSecurityProfile  newSec,
string  reason,
Location  loc,
TrimDateTime  atTime 
)

Modify the security classification of this record.

void HP.HPTRIM.SDK.ClassifiedSecurity.SetDeclassifyData ( RecordDeclassifyTypes  declassifyType,
int  declassifyYears,
TrimDateTime  declassifyDate,
string  declassifyText,
string  declassifyInstructions 
)

Set schedule for declassification of this record.

void HP.HPTRIM.SDK.ClassifiedSecurity.SetDowngradeData ( RecordDeclassifyTypes  downgradeType,
int  downgradeYears,
TrimDateTime  downgradeDate,
string  downgradeText,
string  downgradeInstructions 
)

Set schedule for downgrading the classification of this record.

void HP.HPTRIM.SDK.ClassifiedSecurity.SetInitialData ( string  primordialSecurity,
TrimSecurityProfile  sec,
string  reason,
string  derivedFromOther,
string  ClassifiedBy,
TrimDateTime  atTime,
string  classifyingAgency,
SecurityGuideList  DerivedFromSecurityGuideEntries 
)

Set initial security classification of this record.

void HP.HPTRIM.SDK.ClassifiedSecurity.SetReviewed ( Location  loc,
TrimDateTime  atTime 
)

Set details of a classification review for this record.

Property Documentation

string HP.HPTRIM.SDK.ClassifiedSecurity.ClassifiedBy
get

Gets a string describing the person responsible for the initial security classification.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.ClassifiedOn
get

Gets a string describing the date that the security classification of the record was made.

string HP.HPTRIM.SDK.ClassifiedSecurity.ClassifyingAgency
get

Gets a string describing the agency responsible for the initial security classification.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.DeclassifyDate
get

Gets a date indicate a specific date for declassification of the record (if DeclassifyType is based on a specific date).

string HP.HPTRIM.SDK.ClassifiedSecurity.DeclassifyInstructions
get

Gets a string describing how the actual declassification of the record should be undertaken.

string HP.HPTRIM.SDK.ClassifiedSecurity.DeclassifyText
get

Gets a string describing the event that should cause declassification (if DeclassifyType is based on an event occurring).

RecordDeclassifyTypes HP.HPTRIM.SDK.ClassifiedSecurity.DeclassifyType
get

Gets a RecordDeclassifyTypes enum value indicating what type of process is to be used for determining the record declassification date.

int HP.HPTRIM.SDK.ClassifiedSecurity.DeclassifyYears
get

Gets a number indicating the number of years the record classification should be kept (if DeclassifyType is based on a number of years).

string HP.HPTRIM.SDK.ClassifiedSecurity.DerivedFrom
get

Gets a string describing the which authority or reference was used in determining the security classification of the record.

SecurityGuideList HP.HPTRIM.SDK.ClassifiedSecurity.DerivedFromGuideEntries
get

Gets a array of security guide entries used in determining the security classification of the record.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.DowngradeDate
get

Gets a date indicate a specific date for downgrade of the security classification of the record (if DowngradeType is based on a specific date).

string HP.HPTRIM.SDK.ClassifiedSecurity.DowngradeInstructions
get

Gets a string describing how the actual downgrading of the security classification of the record should be undertaken.

string HP.HPTRIM.SDK.ClassifiedSecurity.DowngradeText
get

Gets a string describing the event that should cause a downgrade of the security classification of the record (if DowngradeType is based on an event occurring).

RecordDeclassifyTypes HP.HPTRIM.SDK.ClassifiedSecurity.DowngradeType
get

Gets a RecordDeclassifyTypes enum value indicating what type of process is to be used for determining when the record security classification should be downgraded.

int HP.HPTRIM.SDK.ClassifiedSecurity.DowngradeYears
get

Gets a number indicating the number of years the record security classification should be kept prior to being downgraded (if DowngradeType is based on a number of years).

SecurityLevel HP.HPTRIM.SDK.ClassifiedSecurity.InitialSecurityLevel
get

Gets the initial security classification of this record (before any declassification or downgrade activity has been undertaken).

Location HP.HPTRIM.SDK.ClassifiedSecurity.LastReviewedBy
get

Gets the location responsible for the most recent review of the security classification.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.LastReviewedOn
get

Gets a date and time indicating when the security classification was most recently reviewed.

Location HP.HPTRIM.SDK.ClassifiedSecurity.LastUpdatedBy
get

Gets the location responsible for the most recent change to the security classification.

string HP.HPTRIM.SDK.ClassifiedSecurity.LastUpdatedDescription
get

Gets a string describing the the most recent change that was made to the security classification.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.LastUpdatedOn
get

Gets a date and time indicating when the security classification was last modified.

string HP.HPTRIM.SDK.ClassifiedSecurity.LastUpdatedReason
get

Gets a string describing the reason for the most recent change to the security classification.

string HP.HPTRIM.SDK.ClassifiedSecurity.PrimordialSecurity
get

Gets a string describing the security classification of this record prior to it entering the TRIM system.

string HP.HPTRIM.SDK.ClassifiedSecurity.ReasonForClassification
get

Gets a string describing the reason for the initial security classification of this record.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.ScheduledDeclassificationDate
get

Gets a date that is calculated to be the date when this record should be declassified.

TrimDateTime HP.HPTRIM.SDK.ClassifiedSecurity.ScheduledDowngradeDate
get

Gets a date that is calculated to be the date when the security classification of the record should be downgraded.