HP.HPTRIM.SDK.TrimSecurityProfile Class Reference

The TrimSecurityProfile class is used to encapsulate the components of a security profile - these being a single security level which is a simple numerical scale, and an array of up to 45 user defined caveats which can either be on or off. More...

Public Member Functions
	TrimSecurityProfile (Database fromDB)
void	AddCaveat (SecurityCaveat caveatToAdd)
	Adds the given Security Caveat object to the list of caveats in this security profile More...
void	AddCaveat (int caveatIdToAdd)
void	RemoveCaveat (SecurityCaveat caveatToRemove)
	Removes the given Security Caveat object from the list of caveats in this security profile More...
void	RemoveCaveat (int caveatIdToRemove)
bool	IsCaveatOn (SecurityCaveat caveatToTest)
	Returns a Boolean value indicating whether a given Security Caveat is currently active in this security profile More...
bool	IsCaveatOn (int caveatIdToTest)
bool	CanAccess (TrimSecurityProfile anotherObjectsSecurity)
	Compares this security level with another to determine if an object with this security level is suitable to access another objected with the nominated security level. It will return true if this profiles security level number is greater than or equal to the supplied profile's level number, and that all the caveats that are on in the supplied profile are also on in this profile. More...
void	UpgradeTo (TrimSecurityProfile anotherSecurityProfile)
	This function will increase the security level number if necessary and possibly add caveats such that it will satisfy the CanAccess test for the supplied profile. More...

Properties
SecurityLevel	SecurityLevel [get, set]
	Gets or sets the security level associated with this security profile More...
int	SecurityLevelNumber [get, set]
	Gets or sets the security level associated with this security profile, using the security level number property. More...
string	AsString [get, set]
	Gets or sets the security profile based on a formatted string. The string contains the abbreviation of the security level, followed by one or more caveat abbreviations, separated by commas. More...
string	AsEmailString [get]
	Gets the security profile as a specially formatted string suitable for inclusion in email header. Some mail systems automatically parse messages based on this string. More...
bool	IsModified [get]
	Gets a boolean parameter indicating if any changes have been made to this profile since it was first constructed. More...
bool	AlwaysHighest [get, set]
	Gets or sets a boolean parameter indicating that this security profile is in an 'always highest' state. It is the equivalent of having a security level number > 99 and having every caveat turned on. More...

Detailed Description

The TrimSecurityProfile class is used to encapsulate the components of a security profile - these being a single security level which is a simple numerical scale, and an array of up to 45 user defined caveats which can either be on or off.

Constructor & Destructor Documentation

HP.HPTRIM.SDK.TrimSecurityProfile.TrimSecurityProfile

(

Database

fromDB

)

Member Function Documentation

void HP.HPTRIM.SDK.TrimSecurityProfile.AddCaveat

(

SecurityCaveat

caveatToAdd

)

Adds the given Security Caveat object to the list of caveats in this security profile

void HP.HPTRIM.SDK.TrimSecurityProfile.AddCaveat

(

int

caveatIdToAdd

)

bool HP.HPTRIM.SDK.TrimSecurityProfile.CanAccess

(

TrimSecurityProfile

anotherObjectsSecurity

)

Compares this security level with another to determine if an object with this security level is suitable to access another objected with the nominated security level. It will return true if this profiles security level number is greater than or equal to the supplied profile's level number, and that all the caveats that are on in the supplied profile are also on in this profile.

bool HP.HPTRIM.SDK.TrimSecurityProfile.IsCaveatOn

(

SecurityCaveat

caveatToTest

)

Returns a Boolean value indicating whether a given Security Caveat is currently active in this security profile

bool HP.HPTRIM.SDK.TrimSecurityProfile.IsCaveatOn

(

int

caveatIdToTest

)

void HP.HPTRIM.SDK.TrimSecurityProfile.RemoveCaveat

(

SecurityCaveat

caveatToRemove

)

Removes the given Security Caveat object from the list of caveats in this security profile

void HP.HPTRIM.SDK.TrimSecurityProfile.RemoveCaveat

(

int

caveatIdToRemove

)

void HP.HPTRIM.SDK.TrimSecurityProfile.UpgradeTo

(

TrimSecurityProfile

anotherSecurityProfile

)

This function will increase the security level number if necessary and possibly add caveats such that it will satisfy the CanAccess test for the supplied profile.

Property Documentation

bool HP.HPTRIM.SDK.TrimSecurityProfile.AlwaysHighest

getset

Gets or sets a boolean parameter indicating that this security profile is in an 'always highest' state. It is the equivalent of having a security level number > 99 and having every caveat turned on.

string HP.HPTRIM.SDK.TrimSecurityProfile.AsEmailString

get

Gets the security profile as a specially formatted string suitable for inclusion in email header. Some mail systems automatically parse messages based on this string.

string HP.HPTRIM.SDK.TrimSecurityProfile.AsString

getset

Gets or sets the security profile based on a formatted string. The string contains the abbreviation of the security level, followed by one or more caveat abbreviations, separated by commas.

bool HP.HPTRIM.SDK.TrimSecurityProfile.IsModified

get

Gets a boolean parameter indicating if any changes have been made to this profile since it was first constructed.

SecurityLevel HP.HPTRIM.SDK.TrimSecurityProfile.SecurityLevel

getset

Gets or sets the security level associated with this security profile

int HP.HPTRIM.SDK.TrimSecurityProfile.SecurityLevelNumber

getset

Gets or sets the security level associated with this security profile, using the security level number property.