Describes standard security settings which can be used in specialised security scenarios More...

Inheritance diagram for TRIM.SDK.SecurityGuide:

Public Member Functions
	SecurityGuide (Database database, TrimURI uri)

	SecurityGuide (Database database, string name)

	SecurityGuide (Database database)

SecurityGuide	NewCopy ()

void	SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)
	Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them. More...

UserFieldValue	GetFieldValue (FieldDefinition userFieldType)
	Gets the value of the nominated user-defined field for this object. More...

void	SetFieldValue (FieldDefinition userFieldType, UserFieldValue newValue)
	Sets the value of the nominated user-defined field for this object. More...

string	GetFieldValueAsString (FieldDefinition userFieldType, StringDisplayType fieldValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a user-defined field value in a format appropriate for a specific use. More...

void	SetActiveDateRange (TrimDateTime validFromDate, TrimDateTime validToDate)
	Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges. More...

Public Member Functions inherited from TRIM.SDK.TrimMainObject
virtual void	Save ()
	Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...

string	MakeReference (string SuggestName)
	Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...

virtual void	Delete ()
	Permanently removes this object and all its associated child objects from the database. More...

bool	IsDeleteOk ()
	Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...

bool	Verify (bool failOnWarning)
	Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...

TrimChildObjectList	GetChildObjectList (BaseObjectTypes childType)
	Retrieves the child object collection of the nominated child object type. More...

TrimMainObject	GetNewCopy ()
	Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...

virtual void	Refresh ()
	Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...

virtual void	Reindex (bool doWordIndex, bool doAdditionalFields, bool doContentEngine)
	Sends an indexing request to the event processor to update main text index on the object, indexes for additional fields or indexes for the content engine. More...

Public Member Functions inherited from TRIM.SDK.TrimObject
bool	IsMandatory (FieldDefinition field)
	Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...

bool	IsValidFor (int purpose)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...

bool	IsValidFor (int purpose, TrimMainObject purposeExtraObject)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...

bool	IsValidFor (int purpose, int purposeExtraEnumValue)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...

bool	HasPermission (GenericPermissions prm)
	Checks to see if the currently logged in user has permission to perform the generic action on this object More...

bool	HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
	Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object More...

Public Member Functions inherited from TRIM.SDK.TrimPropertySet
TrimIcon	GetPropertyIcon (PropertyIds propertyId)
	Gets the icon value associated the a property of this object. More...

TrimMainObject	GetPropertyTrimObject (PropertyIds dnPropId)

string	GetPropertyString (PropertyIds dnPropId)

int	GetPropertyLong (PropertyIds dnPropId)

long	GetPropertyLong64 (PropertyIds dnPropId)

bool	GetPropertyBool (PropertyIds dnPropId)

TrimDateTime	GetPropertyDate (PropertyIds dnPropId)

TrimDecimal	GetPropertyDecimal (PropertyIds dnPropId)

TrimCurrency	GetPropertyCurrency (PropertyIds dnPropId)

TrimURI	GetPropertyUri (PropertyIds dnPropId)

bool	SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)

bool	SetPropertyString (PropertyIds dnPropId, string newValue)

bool	SetPropertyLong (PropertyIds dnPropId, int newValue)

bool	SetPropertyLong64 (PropertyIds dnPropId, long newValue)

bool	SetPropertyBool (PropertyIds dnPropId, bool newValue)

bool	SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)

bool	SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)

bool	SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)

bool	SetPropertyDouble (PropertyIds dnPropId, double newValue)

bool	SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)

bool	ClearProperty (PropertyIds dnPropId)

object	GetProperty (PropertyIds propId)

bool	SetProperty (PropertyIds propId, object newValue)

string	GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a property value in a format appropriate for a specific use. More...

bool	IsMandatory (PropertyIds propertyId)
	Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...

bool	VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
	Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...

bool	CanModifyProperty (PropertyIds propertyId)
	Indicates whether the current user has the permission to modify the specified property. More...

Properties
string	Declassify `[get]`
	Gets a string containing details of the declassification process for records using this Security Guide Entry. These details are determined by the value of the SecurityGuide.DeclassifyType property and the relevant values of the DeclassifyEvent, DeclassifyYears, DeclassifyExemption or DeclassifyDate properties. More...

TrimDateTime	DeclassifyDate `[get, set]`
	Gets or sets the date upon which records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.Exempt' to activate this property. More...

string	DeclassifyEvent `[get, set]`
	Gets or sets a string containing a description of the event upon which records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterEvent' to activate this property. More...

string	DeclassifyExemption `[get, set]`
	Gets or sets a string containing the reason for this record to be exempt from declassification. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterDate' to activate this property. More...

int	DeclassifyYears `[get, set]`
	Gets or sets a number indicating the number of years after publication that records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterDate' to activate this property. More...

string	Description `[get, set]`
	Gets or sets a string containing a description for this Security Guide Entry. More...

string	EntryReference `[get, set]`
	Gets or sets a string containing the reference number identifying the Security Guide Entry corresponding to this SecurityGuide object. More...

string	Reason `[get, set]`
	Gets or sets a string containing the reason for applying this Security Guide Entry to a record. More...

string	SecurityString `[get, set]`
	Gets or sets a string listing the security level and security caveats assigned to this Security Guide, delimited by commas ','. The first element listed is always the security level, followed by the caveats. More...

DeclassifyType	TypeOfDeclassification `[get, set]`
	Gets or sets a DeclassifyType enum value indicating the type of declassification that should occur to records using this Security Guide Entry. The values are 'dcExempt' for which the record should be exempt from declassification (the reason for this held in the DeclassifyExemption property); 'dcAfterDate' for which the record should be declassified after a specified date or a specified number of years after publication (the date for this held in the DeclassifyDate property, or number of years in the DeclassifyYears property); or 'dcAfterEvent' for which the record should be declassified after a specified event (details of the specific event held in the DeclassifyEvent property) More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

TrimSecurityProfile?	SecurityProfile `[get, set]`

TrimDateTime	DateActiveFrom `[get]`

TrimDateTime	DateActiveTo `[get]`

string	ActiveDateRangeDescription `[get]`

bool	IsActive `[get]`

Properties inherited from TRIM.SDK.TrimMainObject
TrimDateTime	LastUpdatedOn `[get]`
	Returns the date and time that changes to this object were last committed. More...

Location?	LastUpdatedBy `[get]`
	Returns the user that committed the most recent change to this object. More...

string	Name `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

bool	Verified `[get]`
	Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...

string	WebURL `[get]`

bool	IsInFavorites `[get]`
	Gets a boolean value indicating whether this object is in the current user's list of favorites More...

string	UpdateComment `[get, set]`
	Gets or sets a string value to be recorded with any audit entries related to the update of this object More...

Properties inherited from TRIM.SDK.TrimObject
BaseObjectTypes	TrimType `[get]`
	Gets a BaseObjectTypes enum value indicating the type of this object. More...

TrimURI	Uri `[get]`
	Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...

string	URN `[get]`
	Gets the uniform resource name for this object. More...

string	NameString `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

string	NameStringExtra `[get]`
	Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...

bool	IsReadOnly `[get]`
	Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...

bool	PossiblyHasSubordinates `[get]`
	Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. More...

Properties inherited from TRIM.SDK.TrimPropertySet
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...

Database	Database `[get]`
	Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...

virtual string	Caption `[get]`
	Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...

virtual TrimIcon	Icon `[get]`
	Gets the icon value associated this TrimPropertySet. More...

bool	IsModified `[get]`
	Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...

Properties inherited from TRIM.SDK.ITrimNotes
bool	CanModifyExistingNotes `[get]`
	Gets a boolean parameter indicating whether the current user can modify the existing notes attached to this object. More...

bool	CanAddToNotes `[get]`
	Gets a boolean value indicating whether the current user can either append or prepend some text to the existing notes. More...

string	Notes `[get, set]`
	Gets or sets a string value corresponding to the notes attached to this object. More...

Properties inherited from TRIM.SDK.ITrimSecurity
TrimSecurityProfile	SecurityProfile `[get, set]`
	Gets or sets the security profile attached to this object. More...

Properties inherited from TRIM.SDK.ITrimActiveDates
TrimDateTime	DateActiveFrom `[get]`
	Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...

TrimDateTime	DateActiveTo `[get]`
	Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...

string	ActiveDateRangeDescription `[get]`
	Gets a string describing the period during which this object was active. More...

bool	IsActive `[get]`
	Gets a boolean value indicating whether this object is currently active. More...

Detailed Description

Describes standard security settings which can be used in specialised security scenarios

Constructor & Destructor Documentation

◆ SecurityGuide() [1/3]

TRIM.SDK.SecurityGuide.SecurityGuide	(	Database	database,
		TrimURI	uri
	)

◆ SecurityGuide() [2/3]

TRIM.SDK.SecurityGuide.SecurityGuide	(	Database	database,
		string	name
	)

◆ SecurityGuide() [3/3]

TRIM.SDK.SecurityGuide.SecurityGuide ( Database database )

Member Function Documentation

◆ GetFieldValue()

UserFieldValue TRIM.SDK.SecurityGuide.GetFieldValue ( FieldDefinition userFieldType )

Gets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.SecurityGuide.GetFieldValueAsString	(	FieldDefinition	userFieldType,
		StringDisplayType	fieldValueStringType,
		bool	useHTMLEscapeChars
	)

Gets a string representation of a user-defined field value in a format appropriate for a specific use.

Implements TRIM.SDK.ITrimUserFields.

◆ NewCopy()

SecurityGuide TRIM.SDK.SecurityGuide.NewCopy ( )

◆ SetActiveDateRange()

void TRIM.SDK.SecurityGuide.SetActiveDateRange	(	TrimDateTime	validFromDate,
		TrimDateTime	validToDate
	)

Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges.

Implements TRIM.SDK.ITrimActiveDates.

◆ SetFieldValue()

void TRIM.SDK.SecurityGuide.SetFieldValue	(	FieldDefinition	userFieldType,
		UserFieldValue	newFieldValue
	)

Sets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ SetNotes()

void TRIM.SDK.SecurityGuide.SetNotes	(	string	NewNotesText,
		NotesUpdateType	TypeOfNotesUpdate
	)

Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them.

Implements TRIM.SDK.ITrimNotes.

Property Documentation

◆ ActiveDateRangeDescription

string TRIM.SDK.SecurityGuide.ActiveDateRangeDescription

get

◆ CanAddToNotes

bool TRIM.SDK.SecurityGuide.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.SecurityGuide.CanModifyExistingNotes

get

◆ DateActiveFrom

TrimDateTime TRIM.SDK.SecurityGuide.DateActiveFrom

get

◆ DateActiveTo

TrimDateTime TRIM.SDK.SecurityGuide.DateActiveTo

get

◆ Declassify

string TRIM.SDK.SecurityGuide.Declassify

get

Gets a string containing details of the declassification process for records using this Security Guide Entry. These details are determined by the value of the SecurityGuide.DeclassifyType property and the relevant values of the DeclassifyEvent, DeclassifyYears, DeclassifyExemption or DeclassifyDate properties.

◆ DeclassifyDate

TrimDateTime TRIM.SDK.SecurityGuide.DeclassifyDate

getset

Gets or sets the date upon which records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.Exempt' to activate this property.

◆ DeclassifyEvent

string TRIM.SDK.SecurityGuide.DeclassifyEvent

getset

Gets or sets a string containing a description of the event upon which records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterEvent' to activate this property.

◆ DeclassifyExemption

string TRIM.SDK.SecurityGuide.DeclassifyExemption

getset

Gets or sets a string containing the reason for this record to be exempt from declassification. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterDate' to activate this property.

◆ DeclassifyYears

int TRIM.SDK.SecurityGuide.DeclassifyYears

getset

Gets or sets a number indicating the number of years after publication that records using this Security Guide Entry should be declassified. The SecurityGuide.DeclassifyType must be set to 'DeclassifyType.AfterDate' to activate this property.

◆ Description

string TRIM.SDK.SecurityGuide.Description

getset

Gets or sets a string containing a description for this Security Guide Entry.

◆ EntryReference

string TRIM.SDK.SecurityGuide.EntryReference

getset

Gets or sets a string containing the reference number identifying the Security Guide Entry corresponding to this SecurityGuide object.

◆ IsActive

bool TRIM.SDK.SecurityGuide.IsActive

get

◆ Notes

string TRIM.SDK.SecurityGuide.Notes

getset

◆ Reason

string TRIM.SDK.SecurityGuide.Reason

getset

Gets or sets a string containing the reason for applying this Security Guide Entry to a record.

◆ SecurityProfile

TrimSecurityProfile? TRIM.SDK.SecurityGuide.SecurityProfile

getset

◆ SecurityString

string TRIM.SDK.SecurityGuide.SecurityString

getset

Gets or sets a string listing the security level and security caveats assigned to this Security Guide, delimited by commas ','. The first element listed is always the security level, followed by the caveats.

◆ TypeOfDeclassification

DeclassifyType TRIM.SDK.SecurityGuide.TypeOfDeclassification

getset

Gets or sets a DeclassifyType enum value indicating the type of declassification that should occur to records using this Security Guide Entry. The values are 'dcExempt' for which the record should be exempt from declassification (the reason for this held in the DeclassifyExemption property); 'dcAfterDate' for which the record should be declassified after a specified date or a specified number of years after publication (the date for this held in the DeclassifyDate property, or number of years in the DeclassifyYears property); or 'dcAfterEvent' for which the record should be declassified after a specified event (details of the specific event held in the DeclassifyEvent property)

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SecurityGuide() [1/3]

◆ SecurityGuide() [2/3]

◆ SecurityGuide() [3/3]

Member Function Documentation

◆ GetFieldValue()

◆ GetFieldValueAsString()

◆ NewCopy()

◆ SetActiveDateRange()

◆ SetFieldValue()

◆ SetNotes()

Property Documentation

◆ ActiveDateRangeDescription

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ DateActiveFrom

◆ DateActiveTo

◆ Declassify

◆ DeclassifyDate

◆ DeclassifyEvent

◆ DeclassifyExemption

◆ DeclassifyYears

◆ Description

◆ EntryReference

◆ IsActive

◆ Notes

◆ Reason

◆ SecurityProfile

◆ SecurityString

◆ TypeOfDeclassification