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

A workflow template is a predefined workflow that is designed to be applied repetitively as part of an organization's ongoing business processes More...

Inheritance diagram for HP.HPTRIM.SDK.WorkflowTemplate:
HP.HPTRIM.SDK.TrimMainObject HP.HPTRIM.SDK.ITrimNotes HP.HPTRIM.SDK.ITrimAccessControl HP.HPTRIM.SDK.ITrimAccessControlDefault HP.HPTRIM.SDK.ITrimActiveDates HP.HPTRIM.SDK.ITrimLabels HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

 WorkflowTemplate (Database database, TrimURI uri)
 
 WorkflowTemplate (Database database, string name)
 
 WorkflowTemplate (Database database)
 
Activity NewActivity ()
 
Activity FindActivityById (int lookForActivityID, bool searchRecursively)
 
Activity FindActivityByName (string lookForName, bool searchRecursively)
 
Activity GetActivity (int activityIndex)
 
Workflow NewWorkflow (Record withInitiatingRecord)
 
void Lock ()
 
void Unlock ()
 
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...
 
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 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...
 
- 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...
 

Properties

bool AutoStartActivities [get, set]
 Gets or sets a boolean value indicating whether to automatically start any activities that are ready to start. More...
 
TrimDateTime DateRegistered [get]
 Gets the date this template was registered in HPE Content Manager. More...
 
Record DefaultContainer [get, set]
 Gets the Record object which should be the default container of Workflows generated using this template. The default container is used to contain any new records attached to the Workflow as Workflow Documents. More...
 
Priority DefaultPriority [get, set]
 Gets or sets a piPriority enum value indicating the priority of this workflow template. More...
 
bool EmailSupervisor [get, set]
 Gets or sets a boolean value indicating whether notification email messages will be sent to supervisor. More...
 
InitiatingRecordBehavior InitRecordBehavior [get, set]
 Gets or sets a initiatingRecordBehavior value indicating how to use initiating record. More...
 
Location LockedBy [get]
 Gets the location object that currently has this template locked. More...
 
TrimDateTime LockedOn [get]
 Gets the date and time that that this template was locked. More...
 
string LockStatus [get]
 Gets a string describing the current lock status of this template. More...
 
int MonthsToKeep [get, set]
 Gets or sets the number of month for that all workflows which are created based on this Workflow Template will be kept before being destroyed. More...
 
new string Name [get, set]
 Gets or sets a string containing the name of this workflow template. More...
 
TrimCurrency OverheadCost [get, set]
 Gets or sets a currency value indicating an overhead cost for the workflow that is additional to the sum of activity costs. More...
 
bool RecalcWhenFinishEarly [get, set]
 Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on actual date completed if an activity is completed before its due date. More...
 
bool RecalcWhenFinishLate [get, set]
 Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on actual date completed if an activity is completed after its due date. More...
 
bool RecalcWhenSuspended [get, set]
 Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on increasing the estimated duration by the total duration an activity is suspended. More...
 
RecordType RecordType [get, set]
 Gets or sets the RecordType object which will be used as default record type of those workflows created using this template. More...
 
Location Supervisor [get, set]
 Gets or sets the location which should be the supervisor of any Workflow generated using this template. The supervisor is responsible for overseeing the progress and completion of the Workflow. More...
 
TrimCurrency TotalEstimatedCost [get]
 Gets or sets a currency value indicating total cost of whole workflow template. More...
 
long TotalEstimatedDuration [get]
 Gets an integer value indicating total estimated duration of this template (in seconds). More...
 
WorkflowTemplateDocuments ChildDocuments [get]
 Get the list of Documents More...
 
int ActivityCount [get]
 
bool CanModifyExistingNotes [get]
 
bool CanAddToNotes [get]
 
string Notes [get, set]
 
TrimAccessControlList AccessControlList [get, set]
 
TrimAccessControlList DefaultAccessControlList [get, set]
 
TrimDateTime DateActiveFrom [get]
 
TrimDateTime DateActiveTo [get]
 
string ActiveDateRangeDescription [get]
 
bool IsActive [get]
 
- 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...
 
- 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...
 
- Properties inherited from HP.HPTRIM.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 HP.HPTRIM.SDK.ITrimAccessControl
TrimAccessControlList AccessControlList [get, set]
 Gets or sets the access control list attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimAccessControlDefault
TrimAccessControlList DefaultAccessControlList [get, set]
 Gets or sets the default reference or copied access control list attached to this object. More...
 
- Properties inherited from HP.HPTRIM.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

A workflow template is a predefined workflow that is designed to be applied repetitively as part of an organization's ongoing business processes

Constructor & Destructor Documentation

HP.HPTRIM.SDK.WorkflowTemplate.WorkflowTemplate ( Database  database,
TrimURI  uri 
)
HP.HPTRIM.SDK.WorkflowTemplate.WorkflowTemplate ( Database  database,
string  name 
)
HP.HPTRIM.SDK.WorkflowTemplate.WorkflowTemplate ( Database  database)

Member Function Documentation

void HP.HPTRIM.SDK.WorkflowTemplate.AddToFavorites ( )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.WorkflowTemplate.ApplyUserLabel ( UserLabel  userLabelToApply)

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

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.WorkflowTemplate.ChangePositionWithinFavorites ( LabelPositionChange  positionChange)

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

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.WorkflowTemplate.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 HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.WorkflowTemplate.DetachUserLabel ( UserLabel  userLabelToDetach)

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

Implements HP.HPTRIM.SDK.ITrimLabels.

Activity HP.HPTRIM.SDK.WorkflowTemplate.FindActivityById ( int  lookForActivityID,
bool  searchRecursively 
)
Activity HP.HPTRIM.SDK.WorkflowTemplate.FindActivityByName ( string  lookForName,
bool  searchRecursively 
)
Activity HP.HPTRIM.SDK.WorkflowTemplate.GetActivity ( int  activityIndex)
void HP.HPTRIM.SDK.WorkflowTemplate.Lock ( )
Activity HP.HPTRIM.SDK.WorkflowTemplate.NewActivity ( )
Workflow HP.HPTRIM.SDK.WorkflowTemplate.NewWorkflow ( Record  withInitiatingRecord)
void HP.HPTRIM.SDK.WorkflowTemplate.RemoveFromFavorites ( )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.WorkflowTemplate.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 HP.HPTRIM.SDK.ITrimActiveDates.

void HP.HPTRIM.SDK.WorkflowTemplate.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 HP.HPTRIM.SDK.ITrimNotes.

void HP.HPTRIM.SDK.WorkflowTemplate.Unlock ( )

Property Documentation

TrimAccessControlList HP.HPTRIM.SDK.WorkflowTemplate.AccessControlList
getset
string HP.HPTRIM.SDK.WorkflowTemplate.ActiveDateRangeDescription
get
int HP.HPTRIM.SDK.WorkflowTemplate.ActivityCount
get
bool HP.HPTRIM.SDK.WorkflowTemplate.AutoStartActivities
getset

Gets or sets a boolean value indicating whether to automatically start any activities that are ready to start.

bool HP.HPTRIM.SDK.WorkflowTemplate.CanAddToNotes
get
bool HP.HPTRIM.SDK.WorkflowTemplate.CanModifyExistingNotes
get
WorkflowTemplateDocuments HP.HPTRIM.SDK.WorkflowTemplate.ChildDocuments
get

Get the list of Documents

TrimDateTime HP.HPTRIM.SDK.WorkflowTemplate.DateActiveFrom
get
TrimDateTime HP.HPTRIM.SDK.WorkflowTemplate.DateActiveTo
get
TrimDateTime HP.HPTRIM.SDK.WorkflowTemplate.DateRegistered
get

Gets the date this template was registered in HPE Content Manager.

TrimAccessControlList HP.HPTRIM.SDK.WorkflowTemplate.DefaultAccessControlList
getset
Record HP.HPTRIM.SDK.WorkflowTemplate.DefaultContainer
getset

Gets the Record object which should be the default container of Workflows generated using this template. The default container is used to contain any new records attached to the Workflow as Workflow Documents.

Priority HP.HPTRIM.SDK.WorkflowTemplate.DefaultPriority
getset

Gets or sets a piPriority enum value indicating the priority of this workflow template.

bool HP.HPTRIM.SDK.WorkflowTemplate.EmailSupervisor
getset

Gets or sets a boolean value indicating whether notification email messages will be sent to supervisor.

InitiatingRecordBehavior HP.HPTRIM.SDK.WorkflowTemplate.InitRecordBehavior
getset

Gets or sets a initiatingRecordBehavior value indicating how to use initiating record.

bool HP.HPTRIM.SDK.WorkflowTemplate.IsActive
get
Location HP.HPTRIM.SDK.WorkflowTemplate.LockedBy
get

Gets the location object that currently has this template locked.

TrimDateTime HP.HPTRIM.SDK.WorkflowTemplate.LockedOn
get

Gets the date and time that that this template was locked.

string HP.HPTRIM.SDK.WorkflowTemplate.LockStatus
get

Gets a string describing the current lock status of this template.

int HP.HPTRIM.SDK.WorkflowTemplate.MonthsToKeep
getset

Gets or sets the number of month for that all workflows which are created based on this Workflow Template will be kept before being destroyed.

new string HP.HPTRIM.SDK.WorkflowTemplate.Name
getset

Gets or sets a string containing the name of this workflow template.

string HP.HPTRIM.SDK.WorkflowTemplate.Notes
getset
TrimCurrency HP.HPTRIM.SDK.WorkflowTemplate.OverheadCost
getset

Gets or sets a currency value indicating an overhead cost for the workflow that is additional to the sum of activity costs.

bool HP.HPTRIM.SDK.WorkflowTemplate.RecalcWhenFinishEarly
getset

Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on actual date completed if an activity is completed before its due date.

bool HP.HPTRIM.SDK.WorkflowTemplate.RecalcWhenFinishLate
getset

Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on actual date completed if an activity is completed after its due date.

bool HP.HPTRIM.SDK.WorkflowTemplate.RecalcWhenSuspended
getset

Gets or sets a boolean value indicating whether due dates for activities should be recalculated based on increasing the estimated duration by the total duration an activity is suspended.

RecordType HP.HPTRIM.SDK.WorkflowTemplate.RecordType
getset

Gets or sets the RecordType object which will be used as default record type of those workflows created using this template.

Location HP.HPTRIM.SDK.WorkflowTemplate.Supervisor
getset

Gets or sets the location which should be the supervisor of any Workflow generated using this template. The supervisor is responsible for overseeing the progress and completion of the Workflow.

TrimCurrency HP.HPTRIM.SDK.WorkflowTemplate.TotalEstimatedCost
get

Gets or sets a currency value indicating total cost of whole workflow template.

long HP.HPTRIM.SDK.WorkflowTemplate.TotalEstimatedDuration
get

Gets an integer value indicating total estimated duration of this template (in seconds).