Describes a computerised task that is to be performed regularly by the Content Manager scheduler
More...
|
| | ScheduledTask (Database database, TrimURI uri) |
| |
| | ScheduledTask (Database database, string name) |
| |
| | ScheduledTask (Database database) |
| |
| 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...
|
| |
 Public Member Functions inherited from HP.HPTRIM.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...
|
| |
| 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...
|
| |
| 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...
|
| |
|
| Location | Assignee [get, set] |
| | Gets or sets the Location object to whom this Scheduled Task is assigned. This location must perform the Scheduled Task. More...
|
| |
| TrimDateTime | AttachDate [get, set] |
| | Gets or sets the date this ScheduledTask object was attached to its record (i.e. the date this Scheduled Task object was created). More...
|
| |
| string | AttachedToObject [get] |
| |
| BaseObjectTypes | AttachedToObjectType [get, set] |
| |
| TrimURI | AttachedToObjectUri [get, set] |
| |
| TrimDateTime | CompletionDate [get, set] |
| | Gets or sets the date this Scheduled Task is due to finish. If this field is left blank, the task will keep repeating forever. More...
|
| |
| string | Description [get] |
| | Gets a string containing a description of what is involved in this Scheduled Task. For example, 'Vital Record Review and Update : Record : G05/1'. More...
|
| |
| int | IntervalSize [get, set] |
| | Gets or sets a diDateInterval enum value indicating the type of time interval between repetitions of this Scheduled Task (e.g. Days, Weeks, Months, Years). The size of the interval of this type is specified in the property 'ScheduledTask.IntervalSize'. More...
|
| |
| DateInterval | IntervalType [get, set] |
| | Gets or sets a diDateInterval enum value indicating the type of time interval between repetitions of this Scheduled Task (e.g. Days, Weeks, Months, Years). The size of the interval of this type is specified in the property 'ScheduledTask.IntervalSize'. More...
|
| |
| bool | IsComplete [get] |
| | Gets a Boolean value indicating whether this Scheduled Task has been completed or not. More...
|
| |
| TrimDateTime | LastActionedOn [get] |
| | Gets the date this Scheduled Task was last performed. If the Scheduled Task has not yet been performed, this date is blank, meaning the property will return the value 30/12/1899 (d,m,y). More...
|
| |
| TrimDateTime | NextDueDate [get] |
| | Gets the date this Scheduled Task is next due to be performed (i.e. due for its next repetition). More...
|
| |
| int | Repetitions [get, set] |
| | Gets or sets an integer containing the maximum number of times this Scheduled Task should be repeated. More...
|
| |
| int | RepetitionsDone [get] |
| | Gets an integer indicating the number of repetitions of this Scheduled Task that have already been carried out. That is, the number of times this Scheduled Task has been performed since it was started. More...
|
| |
| string | ScheduleDescription [get] |
| | Gets a string containing a description of the frequency this Scheduled Task should be performed. Its value is determined by the values of the ScheduledTask.IntervalSize and ScheduledTask.IntervalType properties. For example: 'Perform Scheduled Task every 6 months'. More...
|
| |
| TrimDateTime | StartDate [get, set] |
| | Gets or sets the date this Scheduled Task is due to start. More...
|
| |
| TaskStatus | Status [get] |
| | Gets a tuTaskStatus enum value indicating whether this Scheduled Task is complete, due or overdue. More...
|
| |
| ScheduledTaskHistorys | ChildHistorys [get] |
| | Get the list of Scheduled Task Actions More...
|
| |
| bool | CanModifyExistingNotes [get] |
| |
| bool | CanAddToNotes [get] |
| |
| string | Notes [get, set] |
| |
| Properties inherited from HP.HPTRIM.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...
|
| |
| 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...
|
| |
| 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...
|
| |
| 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...
|
| |
Describes a computerised task that is to be performed regularly by the Content Manager scheduler
1.8.11 
