Micro Focus Content Manager SDK 10.1
TRIM.SDK.Schedule Class Reference

Defines a set of rules that determine the lifecycle of a set of one or more Records More...

Inheritance diagram for TRIM.SDK.Schedule:
TRIM.SDK.TrimMainObject TRIM.SDK.ITrimNotes TRIM.SDK.ITrimUserFields TRIM.SDK.ITrimAccessControl TRIM.SDK.ITrimActiveDates TRIM.SDK.ITrimLabels TRIM.SDK.TrimObject TRIM.SDK.TrimPropertySet

Public Member Functions

 Schedule (Database database, TrimURI uri)
 
 Schedule (Database database, string name)
 
 Schedule (Database database)
 
Schedule NewLowerLevel ()
 
Schedule NewCopy ()
 
void ReplaceReferences (Schedule replacement, bool makeScheduleInactive, bool replaceOnAlreadyArchivedRecords)
 Replaces all references to this schedule (in records, classifications, record types, origins, check in styles). You can also opt to make the schedule inactive after the references are done and also to keep the existing schedule on records that have been archived or destroyed according this schedule. More...
 
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...
 
void ApplyUserLabel (UserLabel userLabelToApply)
 Creates a link between the nominated user label and this object. More...
 
void DetachUserLabel (UserLabel userLabelToDetach)
 Removes the link between the nominated user label and this object. More...
 
void AddToFavorites ()
 Adds the object to the special user label called 'Favorites' More...
 
void RemoveFromFavorites ()
 Removes the object from the special user label called 'Favorites' More...
 
bool ChangePositionWithinFavorites (LabelPositionChange positionChange)
 Changes the position of this object within a users list of favorite objects of this type More...
 
bool ChangePositionWithinUserLabel (UserLabel label, LabelPositionChange positionChange)
 Changes the position of this object within a users list of objects that have been labeled with the specified user label 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 ActionSummary [get]
 Gets a string describing a summary of the retention management actions of this retention schedule. More...
 
bool CanAttach [get, set]
 Gets or sets a boolean value indicating if this retention schedule can be attached to a record. Used when defining an intermediate level with the schedule hierarchy. More...
 
bool CanOnlyDestroyInactive [get, set]
 Gets or sets a boolean value indicating whether records with this retention schedule can only be disposed if they are not currently active. More...
 
TrimDateTime DateSuperseded [get]
 Gets a datetime indicating when a schedule was superseded. More...
 
string ExpandedTitle [get]
 Gets a string which is an expansion of the schedule title by prepending all higher level schedule titles. More...
 
bool HasChildSchedules [get]
 Gets a boolean value indicating if this schedule has any subordinate schedules. More...
 
bool IgnoreBlankDestroyTriggers [get, set]
 Gets or sets a boolean value indicating whether disposal triggers will be ignored if the date calculation results in a blank due date (presumably because a date on the record has not been set) More...
 
bool IsAgencySpecific [get, set]
 Gets or sets a Boolean value indicating whether the schedule only applies to the organization that is using Content Manager, or whether it is a schedule published by an archival authority for use across a number of organizations. More...
 
new string Name [get, set]
 Gets or sets a string containing the schedule number of this Retention Schedule. This number uniquely identifies this Schedule amongst all other Retention Schedules. More...
 
ScheduleParentSchedule [get]
 Gets the parent schedule which this schedule belongs to, if any. More...
 
string PolicyCentreGUID [get, set]
 Gets or sets a GUID value indicating the unique identifier for this retention schedule in the Policy Center integration More...
 
string RetainJurisdictions [get, set]
 Gets or sets a string value containing a list of jurisdictions which have a retain permanent requirement. Only used if the Retain property is set to KeepForeverInSomeJurisdictions. More...
 
RetainOptions Retention [get, set]
 Gets or sets a RetainStyles enumerated value indicating if a retain permanent requirement is in force More...
 
string Source [get, set]
 Gets or sets a string containing the source from which the Retention Schedule originated, e.g. the archival authority publication number. More...
 
ScheduleSupersededBy [get]
 Gets a Schedule object indicating the schedule that supersedes this one. More...
 
bool SuppressTriggerCalculationAlways [get, set]
 Gets or sets a boolean value indicating if the creation of a retention trigger reindex event should be suppressed whenever an updated is committed to this schedule. More...
 
bool SuppressTriggerCalculationEventOnCommit [get, set]
 Gets or sets a boolean value indicating if the creation of a retention trigger reindex event should be suppressed when an update is committed. This setting is transient and needs to be specified whenever the schedule is updated. More...
 
string Title [get, set]
 Gets or sets the title of this Retention Schedule. This is a brief reference to the subject matter of records this schedule will be applied to. More...
 
bool UseEarliestDestroyDate [get, set]
 Gets or sets a boolean value indicating whether the earliest disposal date will be used in a disposition schedule calculation involving multiple destroy triggers (normally the latest destruction date is used). More...
 
ScheduleTriggers ChildTriggers [get]
 Get the list of Triggers More...
 
bool CanModifyExistingNotes [get]
 
bool CanAddToNotes [get]
 
string Notes [get, set]
 
TrimAccessControlListAccessControlList [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...
 
LocationLastUpdatedBy [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.ITrimAccessControl
TrimAccessControlList AccessControlList [get, set]
 Gets or sets the access control list 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

Defines a set of rules that determine the lifecycle of a set of one or more Records

Constructor & Destructor Documentation

◆ Schedule() [1/3]

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

◆ Schedule() [2/3]

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

◆ Schedule() [3/3]

TRIM.SDK.Schedule.Schedule ( Database  database)

Member Function Documentation

◆ AddToFavorites()

void TRIM.SDK.Schedule.AddToFavorites ( )

Adds the object to the special user label called 'Favorites'

Implements TRIM.SDK.ITrimLabels.

◆ ApplyUserLabel()

void TRIM.SDK.Schedule.ApplyUserLabel ( UserLabel  userLabelToApply)

Creates a link between the nominated user label and this object.

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinFavorites()

bool TRIM.SDK.Schedule.ChangePositionWithinFavorites ( LabelPositionChange  positionChange)

Changes the position of this object within a users list of favorite objects of this type

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinUserLabel()

bool TRIM.SDK.Schedule.ChangePositionWithinUserLabel ( UserLabel  userLabelToChange,
LabelPositionChange  positionChange 
)

Changes the position of this object within a users list of objects that have been labeled with the specified user label

Implements TRIM.SDK.ITrimLabels.

◆ DetachUserLabel()

void TRIM.SDK.Schedule.DetachUserLabel ( UserLabel  userLabelToDetach)

Removes the link between the nominated user label and this object.

Implements TRIM.SDK.ITrimLabels.

◆ GetFieldValue()

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

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

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.Schedule.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()

Schedule TRIM.SDK.Schedule.NewCopy ( )

◆ NewLowerLevel()

Schedule TRIM.SDK.Schedule.NewLowerLevel ( )

◆ RemoveFromFavorites()

void TRIM.SDK.Schedule.RemoveFromFavorites ( )

Removes the object from the special user label called 'Favorites'

Implements TRIM.SDK.ITrimLabels.

◆ ReplaceReferences()

void TRIM.SDK.Schedule.ReplaceReferences ( Schedule  replacement,
bool  makeScheduleInactive,
bool  replaceOnAlreadyArchivedRecords 
)

Replaces all references to this schedule (in records, classifications, record types, origins, check in styles). You can also opt to make the schedule inactive after the references are done and also to keep the existing schedule on records that have been archived or destroyed according this schedule.

◆ SetActiveDateRange()

void TRIM.SDK.Schedule.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.Schedule.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.Schedule.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

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.Schedule.AccessControlList
getset

◆ ActionSummary

string TRIM.SDK.Schedule.ActionSummary
get

Gets a string describing a summary of the retention management actions of this retention schedule.

◆ ActiveDateRangeDescription

string TRIM.SDK.Schedule.ActiveDateRangeDescription
get

◆ CanAddToNotes

bool TRIM.SDK.Schedule.CanAddToNotes
get

◆ CanAttach

bool TRIM.SDK.Schedule.CanAttach
getset

Gets or sets a boolean value indicating if this retention schedule can be attached to a record. Used when defining an intermediate level with the schedule hierarchy.

◆ CanModifyExistingNotes

bool TRIM.SDK.Schedule.CanModifyExistingNotes
get

◆ CanOnlyDestroyInactive

bool TRIM.SDK.Schedule.CanOnlyDestroyInactive
getset

Gets or sets a boolean value indicating whether records with this retention schedule can only be disposed if they are not currently active.

◆ ChildTriggers

ScheduleTriggers TRIM.SDK.Schedule.ChildTriggers
get

Get the list of Triggers

◆ DateActiveFrom

TrimDateTime TRIM.SDK.Schedule.DateActiveFrom
get

◆ DateActiveTo

TrimDateTime TRIM.SDK.Schedule.DateActiveTo
get

◆ DateSuperseded

TrimDateTime TRIM.SDK.Schedule.DateSuperseded
get

Gets a datetime indicating when a schedule was superseded.

◆ ExpandedTitle

string TRIM.SDK.Schedule.ExpandedTitle
get

Gets a string which is an expansion of the schedule title by prepending all higher level schedule titles.

◆ HasChildSchedules

bool TRIM.SDK.Schedule.HasChildSchedules
get

Gets a boolean value indicating if this schedule has any subordinate schedules.

◆ IgnoreBlankDestroyTriggers

bool TRIM.SDK.Schedule.IgnoreBlankDestroyTriggers
getset

Gets or sets a boolean value indicating whether disposal triggers will be ignored if the date calculation results in a blank due date (presumably because a date on the record has not been set)

◆ IsActive

bool TRIM.SDK.Schedule.IsActive
get

◆ IsAgencySpecific

bool TRIM.SDK.Schedule.IsAgencySpecific
getset

Gets or sets a Boolean value indicating whether the schedule only applies to the organization that is using Content Manager, or whether it is a schedule published by an archival authority for use across a number of organizations.

◆ Name

new string TRIM.SDK.Schedule.Name
getset

Gets or sets a string containing the schedule number of this Retention Schedule. This number uniquely identifies this Schedule amongst all other Retention Schedules.

◆ Notes

string TRIM.SDK.Schedule.Notes
getset

◆ ParentSchedule

Schedule? TRIM.SDK.Schedule.ParentSchedule
get

Gets the parent schedule which this schedule belongs to, if any.

◆ PolicyCentreGUID

string TRIM.SDK.Schedule.PolicyCentreGUID
getset

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

◆ RetainJurisdictions

string TRIM.SDK.Schedule.RetainJurisdictions
getset

Gets or sets a string value containing a list of jurisdictions which have a retain permanent requirement. Only used if the Retain property is set to KeepForeverInSomeJurisdictions.

◆ Retention

RetainOptions TRIM.SDK.Schedule.Retention
getset

Gets or sets a RetainStyles enumerated value indicating if a retain permanent requirement is in force

◆ Source

string TRIM.SDK.Schedule.Source
getset

Gets or sets a string containing the source from which the Retention Schedule originated, e.g. the archival authority publication number.

◆ SupersededBy

Schedule? TRIM.SDK.Schedule.SupersededBy
get

Gets a Schedule object indicating the schedule that supersedes this one.

◆ SuppressTriggerCalculationAlways

bool TRIM.SDK.Schedule.SuppressTriggerCalculationAlways
getset

Gets or sets a boolean value indicating if the creation of a retention trigger reindex event should be suppressed whenever an updated is committed to this schedule.

◆ SuppressTriggerCalculationEventOnCommit

bool TRIM.SDK.Schedule.SuppressTriggerCalculationEventOnCommit
getset

Gets or sets a boolean value indicating if the creation of a retention trigger reindex event should be suppressed when an update is committed. This setting is transient and needs to be specified whenever the schedule is updated.

◆ Title

string TRIM.SDK.Schedule.Title
getset

Gets or sets the title of this Retention Schedule. This is a brief reference to the subject matter of records this schedule will be applied to.

◆ UseEarliestDestroyDate

bool TRIM.SDK.Schedule.UseEarliestDestroyDate
getset

Gets or sets a boolean value indicating whether the earliest disposal date will be used in a disposition schedule calculation involving multiple destroy triggers (normally the latest destruction date is used).