An activity is the fundamental element of a workflow, and represents a unit of work to be performed by an action officer, usually within a defined time period
More...
|
| Activity () |
| Constructor for the Activity object, based on a supplied unique row identifier. More...
|
|
| Activity (Database db, long activityUri) |
| Constructor for the Activity object, based on a supplied unique row identifier. More...
|
|
| Activity (Database db, TrimURI activityUri) |
| Constructor for the Activity object based on a value for the activityName property. More...
|
|
| Activity (Database db, string activityName) |
|
Activity | NewSubActivity () |
| Creates a new activity to be a sub-activity of this activity More...
|
|
Activity | FindSubActivityById (int lookForActivityID, bool searchRecursively) |
| Gets a subordinate activity of this activity based on the activity ID. More...
|
|
Activity | FindSubActivityByName (string lookForActivityName, bool searchRecursively) |
| Get a subordinate activity of this activity based on the name of that activity. Returns the first activity encountered with a matching name. More...
|
|
Activity | GetSubActivity (int activityIndex) |
| Get a sub activity within this activity with the supplied index. More...
|
|
void | Start () |
| Indicates that work has commenced on this activity More...
|
|
void | Complete () |
| Completes this activity. You must have preset any completion result, and attached records to any document placeholders as appropriate More...
|
|
void | Rollback (int activityIdToRollbackTo, string reasonForRollback) |
| Reverts workflow processing back to a preceding activity, resetting completed state to incomplete for all activities involved More...
|
|
void | Uncomplete (string reasonForSettingIncomplete) |
| Reverts this activity back to an uncompleted state - also used for rejecting an authorization More...
|
|
void | Authorize () |
| Authorizes the completion of this activity More...
|
|
void | Reject (string reasonForRejection) |
| Rejects the authorization of this activity More...
|
|
void | Acquire () |
| Acquires this activity by assigning it to the currenlt logged in user More...
|
|
void | Relinquish () |
| Resets the assignee of this activity back to its original assignee More...
|
|
void | Reassign (Location newAssignee) |
| Reassigns this activity to the nominated user More...
|
|
void | Suspend (string reasonForSuspension, long durationOfSuspension) |
| Suspends work on this activity for the nominated duration - usually required when waiting for outside input. More...
|
|
void | Resume () |
| Reverts an activity back from a suspended state More...
|
|
override 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...
|
|
override void | Delete () |
| Permanently removes this object and all its associated child objects from the database. 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...
|
|
Public Member Functions inherited from HP.HPTRIM.SDK.TrimMainObject |
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...
|
|
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...
|
|
|
int | ActivityId [get] |
| Gets the integer value which uniquely identifies this activity within this workflow or template. More...
|
|
Priority | ActivityPriority [get, set] |
| Gets or sets a piPriority enum value indicating the priority of this Activity. More...
|
|
TrimCurrency | ActualCost [get, set] |
| Gets or sets a currency value indicating the actual cost of completing this activity. More...
|
|
long | ActualDuration [get, set] |
| Gets or sets an integer containing the actual duration of this activity. This indicates the amount of time that was actually taken to complete this activity. The Activity has been completed if the activity.IsComplete property has the value 'true'. More...
|
|
Location | AssignedBy [get] |
| Gets a location object representing the user responsible for allocating the current assignee for this activity. More...
|
|
Location | AssignedTo [get, set] |
| Gets or sets the location that is responsible for completing this activity. More...
|
|
bool | AutoComplete [get, set] |
| Gets or sets a boolean value indicating whether to automatically complete this activity once started More...
|
|
Location | CompletedBy [get] |
| Gets or sets the location that actually completed this activity. More...
|
|
bool | CompletedOnTime [get] |
| Gets a boolean value indicating whether this activity has been completed and was completed before the due date. More...
|
|
TrimDateTime | DateAssigned [get] |
| Gets the date this activity was assigned to the current assignee. More...
|
|
TrimDateTime | DateAuthorized [get] |
| Gets a datetime value indicating when this activity was fully authorized. If this activity has no authorization, this property and 'completed' will have the same value. More...
|
|
TrimDateTime | DateCompleted [get, set] |
| Gets or sets the date this activity was completed, if it has been completed. Note that only a workflow administrator can change a completion date, and only if it is not blank. More...
|
|
TrimDateTime | DateDue [get] |
| Gets the date this activity is due for completion. More...
|
|
TrimDateTime | DateEarliestStart [get] |
| Gets the earliest date on which this activity may be started, based on the quickest available path for completion. More...
|
|
TrimDateTime | DateLatestStart [get] |
| Gets the latest date by which this activity should be started. This date is calculated based on the workflow taking the longest path to completion. More...
|
|
TrimDateTime | DateSkipped [get] |
| Gets a datetime value indicating when this activity was skipped. More...
|
|
TrimDateTime | DateStarted [get, set] |
| Gets or sets the date and time this activity was started. More...
|
|
TrimDateTime | DateSuspended [get] |
| Gets a datetime value indicating that this activity is suspended. More...
|
|
TrimDateTime | DateSuspendedUntil [get] |
| Gets a datetime value indicating when this activity is due to resume. More...
|
|
WorkflowTemplate | DerivedFromTemplate [get] |
| Gets the workflow template object which this activity was derived from. Only applicable for an activity within a workflow (and not a template). More...
|
|
bool | EmailAssigned [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is assigned to a location. More...
|
|
bool | EmailAuthorizable [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is ready for authorization. More...
|
|
bool | EmailCompleted [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is completed. More...
|
|
bool | EmailCurrent [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is ready to start. More...
|
|
bool | EmailEscalated [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is escalated to a location. More...
|
|
bool | EmailOverdue [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity becomes overdue. More...
|
|
bool | EmailReassigned [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is reassigned to a location. More...
|
|
bool | EmailSkipped [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is skipped. More...
|
|
bool | EmailUndone [get, set] |
| Gets or sets a boolean value indicating whether an email notification will be sent when this activity is undone (ie changed from complete to incomplete). More...
|
|
Location | EscalatedTo [get] |
| Gets the location object that the activity has been escalated to, if it has been escalated. More...
|
|
TrimCurrency | EstimatedCost [get, set] |
| Gets or sets a currency value indicating the estimated cost of competing this activity. More...
|
|
long | EstimatedDuration [get, set] |
| Gets or sets an integer containing the originally designed expected duration of this activity in seconds. More...
|
|
bool | HasSubActivities [get] |
| Gets an boolean value indicating if this activity has any sub activities. More...
|
|
bool | IsComplete [get] |
| Gets a boolean value indicating whether this activity has been completed. More...
|
|
bool | IsLastActivity [get] |
| Gets a boolean value indicating whether this is the last activity within this level of activities. More...
|
|
bool | IsOverdue [get] |
| Gets a boolean value indicating whether this activity has not been completed, and is beyond its due date. More...
|
|
bool | IsReadyToStart [get] |
| Gets a Boolean value indicating whether this activity is ready to start. This Activity will be ready to start when all its start conditions are met. More...
|
|
bool | IsStartActivity [get] |
| Gets a Boolean value indicating whether this activity is the first activity in the Workflow. More...
|
|
new string | Name [get, set] |
| Gets or sets a string containing the name of this activity. More...
|
|
string | NormalRect [get, set] |
| Gets or sets the Activity's normal view window size and position information. More...
|
|
Location | OriginalAssignee [get] |
| Gets the location object that was initially assigned to this activity. More...
|
|
string | OutlineRect [get, set] |
| Gets or sets the Activity's outline view window size and position information. More...
|
|
int | ParentActivityId [get] |
| Gets the integer value containing the id number of the parent activity to this activity, if this activity is a subordinate activity. If there is no parent activity, this property has the value '0'. More...
|
|
int | PercentComplete [get, set] |
| Gets or sets an integer between 0 and 100 indicating the percentage of this activity that is complete. This gives an indication of the progress of the Activity. More...
|
|
string | ReasonForSuspension [get] |
| Gets a string value containing the reason for the current suspension. More...
|
|
bool | RequiresAuthorization [get, set] |
| Gets or sets a boolean value indicating whether this activity requires authorization before. it can be considered finally complete. More...
|
|
string | Result [get] |
| Gets a string representing the result of processing this activity. More...
|
|
long | ScheduledDuration [get, set] |
| Gets an integer containing the expected duration of this activity in seconds. This is the same as the estimated duration. More...
|
|
ActivityStates | State [get] |
| Gets a enum value indicating the progress state of this activity. More...
|
|
Location | Supervisor [get, set] |
| Gets or sets the location that is responsible for supervising the progress of this activity. More...
|
|
Location | SuspendedBy [get] |
| Gets the location that suspended this activity. More...
|
|
WorkflowTemplate | Template [get] |
| Gets the workflow template object which this activity belongs to. An activity belongs to either a workflow or a workflow template. More...
|
|
long | TotalSuspensionDuration [get] |
| Gets an integer containing the total number of seconds this activity was suspended. More...
|
|
bool | UseAdvancedCompletionWizard [get, set] |
| Gets or sets a boolean value indicating whether to include all steps in completion wizard. More...
|
|
bool | WasSkipped [get] |
| Gets a boolean value indicating whether this activity was skipped because of a preceding activity not having an apprpriate result More...
|
|
bool | WithinTemplate [get] |
| Gets a boolean value indicating whether this activity is within a workflow template. More...
|
|
Workflow | Workflow [get] |
| Gets the workflow object which this activity belongs to. An activity belongs to either a workflow or a workflow template. More...
|
|
ActivityAuthorizations | ChildAuthorizations [get] |
| Get the list of Authorizations More...
|
|
ActivityDocuments | ChildDocuments [get] |
| Get the list of Documents More...
|
|
ActivityEmailRecipients | ChildEmailRecipients [get] |
| Get the list of Email Recipients More...
|
|
ActivityEscalations | ChildEscalations [get] |
| Get the list of Escalations More...
|
|
ActivityResults | ChildResults [get] |
| Get the list of Results More...
|
|
ActivityStartConditions | ChildStartConditions [get] |
| Get the list of Start Conditions More...
|
|
int | SubActivityCount [get] |
| Gets an integer value indicating the number of sub activities within this activity. 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...
|
|
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...
|
|
An activity is the fundamental element of a workflow, and represents a unit of work to be performed by an action officer, usually within a defined time period