HPE Content Manager SDK 9.1
HP.HPTRIM.SDK.ScheduleTrigger Class Reference

An individual rule of the parent Schedule that defines circumstances under which a Record should undergo archival/disposal action More...

Inheritance diagram for HP.HPTRIM.SDK.ScheduleTrigger:
HP.HPTRIM.SDK.TrimChildObject HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Properties

int AfterDays [get, set]
 Gets or sets an integer indicating how many months this trigger should wait before initiating the disposition change. More...
 
int AfterMonths [get, set]
 Gets or sets an integer indicating how many months this trigger should wait before initiating the disposition change. The value of this property must be between 0 and 11. The length of the waiting period is determined by the combination of the SchTrigger.Years property and this property. The wait begins upon a date event determined by the value of the SchTrigger.DateType property. More...
 
int AfterYears [get, set]
 Gets or sets an integer indicating how many years this trigger should wait before initiating the disposition change. The length of the waiting period is determined by the combination of this property and the SchTrigger.Months property. The wait begins upon a date event determined by the value of the SchTrigger.DateType property. More...
 
TriggerTypes DateType [get, set]
 Gets or sets a tgTriggerTypes enum value indicating a record event upon which the waiting period for this trigger should begin. When the waiting period is over, the record which invoked the trigger is ready to undergo a disposition change according to the type of this trigger. More...
 
TriggerDelayTypes DelayType [get]
 Gets an integer indicating how long after the specified date that this trigger should wait before initiating the disposition change. More...
 
string Description [get]
 Gets a string containing a description of this Trigger. It includes the type of trigger and the date type upon which it is activated, for example: 'Destroy 10 years after Date Inactive' More...
 
TrimDateTime FixedDate [get, set]
 Gets or sets the Fixed Trigger Date upon which date the waiting period for this trigger should begin, if it is to begin on a fixed date. This property is only activated when the SchTrigger.DateType property is set to 'tgTriggerTypes.tgFixedDate'. More...
 
bool IsForDestroy [get]
 Gets a Boolean value indicating whether this SchTrigger is a destroy trigger More...
 
Jurisdiction Jurisdiction [get, set]
 Gets and sets the jurisdiction of this schedule trigger. More...
 
string PolicyCentreGUID [get, set]
 Gets or sets a GUID value indicating the unique identifier for this retention schedule trigger in the Policy Center integration rule list More...
 
string PolicyCentreMappingGUID [get, set]
 Gets or sets a GUID value indicating the unique identifier for this retention schedule trigger in the Policy Center integration rule mapping list More...
 
string PolicyCentreNotes [get, set]
 Gets or sets a string value indicating the disposal event/action associated with this retention schedule trigger in the Policy Center integration More...
 
string PolicyCentreTitle [get, set]
 Gets or sets a string value indicating the title of this retention schedule trigger in the Policy Center integration More...
 
TriggerRounding Rounding [get, set]
 Gets or sets the amount the scheduled date is to be adjusted by rounding up to the end of the appropriate period as indicated in the triggerRounding enumeration. More...
 
Location TransferTo [get, set]
 Gets or sets a Location object that indicates where the new custodian of the records once they have been transferred. More...
 
RecordDisp TriggerType [get, set]
 Gets or sets a rdRecordDisp enum value indicating the type of disposition change this trigger should perform. That is, it represents the new disposition a record should acquire after the waiting period triggered by the date event defined in DateType property has been reached. More...
 
string TriggerTypeDescription [get]
 Gets a string containing a summary description of this retention action trigger. More...
 
FieldDefinition UserDefinedDate [get, set]
 Gets or sets a FieldDefinition object of type DateTime. The value of this user defined date for records using this trigger's Retention Schedule determines the date the waiting period for the trigger should begin, if it is to begin according to a user defined date. This property is only activated when the SchTrigger.DateType property is set to 'tgTriggerTypes.tgUserDefined'. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimChildObject
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...
 
uint Idx [get]
 Gets the position in the child object list that this child object occupies. More...
 
- Properties inherited from HP.HPTRIM.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...
 
- Properties inherited from HP.HPTRIM.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...
 

Additional Inherited Members

- Public Member Functions inherited from HP.HPTRIM.SDK.TrimChildObject
void Delete ()
 Permanently removes this object and all its associated child objects from the database. More...
 
- Public Member Functions inherited from HP.HPTRIM.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...
 
- Public Member Functions inherited from HP.HPTRIM.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...
 

Detailed Description

An individual rule of the parent Schedule that defines circumstances under which a Record should undergo archival/disposal action

Property Documentation

int HP.HPTRIM.SDK.ScheduleTrigger.AfterDays
getset

Gets or sets an integer indicating how many months this trigger should wait before initiating the disposition change.

int HP.HPTRIM.SDK.ScheduleTrigger.AfterMonths
getset

Gets or sets an integer indicating how many months this trigger should wait before initiating the disposition change. The value of this property must be between 0 and 11. The length of the waiting period is determined by the combination of the SchTrigger.Years property and this property. The wait begins upon a date event determined by the value of the SchTrigger.DateType property.

int HP.HPTRIM.SDK.ScheduleTrigger.AfterYears
getset

Gets or sets an integer indicating how many years this trigger should wait before initiating the disposition change. The length of the waiting period is determined by the combination of this property and the SchTrigger.Months property. The wait begins upon a date event determined by the value of the SchTrigger.DateType property.

TriggerTypes HP.HPTRIM.SDK.ScheduleTrigger.DateType
getset

Gets or sets a tgTriggerTypes enum value indicating a record event upon which the waiting period for this trigger should begin. When the waiting period is over, the record which invoked the trigger is ready to undergo a disposition change according to the type of this trigger.

TriggerDelayTypes HP.HPTRIM.SDK.ScheduleTrigger.DelayType
get

Gets an integer indicating how long after the specified date that this trigger should wait before initiating the disposition change.

string HP.HPTRIM.SDK.ScheduleTrigger.Description
get

Gets a string containing a description of this Trigger. It includes the type of trigger and the date type upon which it is activated, for example: 'Destroy 10 years after Date Inactive'

TrimDateTime HP.HPTRIM.SDK.ScheduleTrigger.FixedDate
getset

Gets or sets the Fixed Trigger Date upon which date the waiting period for this trigger should begin, if it is to begin on a fixed date. This property is only activated when the SchTrigger.DateType property is set to 'tgTriggerTypes.tgFixedDate'.

bool HP.HPTRIM.SDK.ScheduleTrigger.IsForDestroy
get

Gets a Boolean value indicating whether this SchTrigger is a destroy trigger

Jurisdiction HP.HPTRIM.SDK.ScheduleTrigger.Jurisdiction
getset

Gets and sets the jurisdiction of this schedule trigger.

string HP.HPTRIM.SDK.ScheduleTrigger.PolicyCentreGUID
getset

Gets or sets a GUID value indicating the unique identifier for this retention schedule trigger in the Policy Center integration rule list

string HP.HPTRIM.SDK.ScheduleTrigger.PolicyCentreMappingGUID
getset

Gets or sets a GUID value indicating the unique identifier for this retention schedule trigger in the Policy Center integration rule mapping list

string HP.HPTRIM.SDK.ScheduleTrigger.PolicyCentreNotes
getset

Gets or sets a string value indicating the disposal event/action associated with this retention schedule trigger in the Policy Center integration

string HP.HPTRIM.SDK.ScheduleTrigger.PolicyCentreTitle
getset

Gets or sets a string value indicating the title of this retention schedule trigger in the Policy Center integration

TriggerRounding HP.HPTRIM.SDK.ScheduleTrigger.Rounding
getset

Gets or sets the amount the scheduled date is to be adjusted by rounding up to the end of the appropriate period as indicated in the triggerRounding enumeration.

Location HP.HPTRIM.SDK.ScheduleTrigger.TransferTo
getset

Gets or sets a Location object that indicates where the new custodian of the records once they have been transferred.

RecordDisp HP.HPTRIM.SDK.ScheduleTrigger.TriggerType
getset

Gets or sets a rdRecordDisp enum value indicating the type of disposition change this trigger should perform. That is, it represents the new disposition a record should acquire after the waiting period triggered by the date event defined in DateType property has been reached.

string HP.HPTRIM.SDK.ScheduleTrigger.TriggerTypeDescription
get

Gets a string containing a summary description of this retention action trigger.

FieldDefinition HP.HPTRIM.SDK.ScheduleTrigger.UserDefinedDate
getset

Gets or sets a FieldDefinition object of type DateTime. The value of this user defined date for records using this trigger's Retention Schedule determines the date the waiting period for the trigger should begin, if it is to begin according to a user defined date. This property is only activated when the SchTrigger.DateType property is set to 'tgTriggerTypes.tgUserDefined'.