A workflow is a structured set of activities that need to be completed according to a set sequence More...

Inheritance diagram for TRIM.SDK.Workflow:

Public Member Functions
	Workflow (Database database, TrimURI uri)

	Workflow (Database database, string name)

	Workflow (Database database)

Activity	NewActivity ()

Activity	FindActivityById (int lookForActivityID, bool searchRecursively)

Activity	FindActivityByName (string name, bool searchRecursively)

Activity	GetActivity (int activityIndex)

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...

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	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
bool	AutoStartActivities `[get, set]`
	Gets or sets a boolean value indicating whether activities should be automatically started when they are ready to start. More...

Location?	Creator `[get]`
	Gets the location who initially created this workflow. More...

Location?	Customer `[get, set]`
	Gets or sets the Location object which is the customer for this workflow. More...

TrimDateTime	DateCompleted `[get]`
	Gets the date this workflow was completed, if it has been completed. More...

TrimDateTime	DateDue `[get, set]`
	Gets or sets the date this workflow is due for completion. More...

TrimDateTime	DateRegistered `[get]`
	Gets the date this workflow was registered in Content Manager. More...

TrimDateTime	DateStarted `[get]`
	Gets the date this workflow was started in Content Manager. More...

Record?	DefaultContainer `[get, set]`
	Gets or sets the Record object which is the default container for this workflow. This is used to contain any new records attached to the Workflow as Workflow Documents. More...

TrimDateTime	DestroyDueDate `[get, set]`
	Gets the date this workflow is due for destruction. More...

bool	EmailSupervisor `[get, set]`
	Gets or sets a boolean value indicating whether notification email messages will be sent to supervisor. More...

bool	Incomplete `[get]`
	Gets a Boolean value indicating whether this workflow is incomplete. More...

Location?	InitialAssignee `[get]`
	Gets the Location object which is the assignee of the first activity in this workflow. More...

Record?	Initiator `[get, set]`
	Gets or sets the Record object by which this workflow process was initiated. More...

bool	IsComplete `[get]`
	Gets a Boolean value indicating whether this workflow is complete. More...

bool	IsOverdue `[get]`
	Gets a Boolean value indicating whether this workflow is overdue. More...

string	JobNumber `[get, set]`
	Gets or sets a string containing the job number for this workflow. This is an automatically generated number of the numbering pattern: 'YYYY/GGGGG'. More...

string	JobNumberExpanded `[get, set]`
	Gets a string containing the job number for this workflow. This is an automatically generated number of the numbering pattern: 'YYYY/GGGGG'. More...

Location?	LockedBy `[get]`
	Gets the location object that currently has this workflow locked. More...

TrimDateTime	LockedOn `[get]`
	Gets the date and time that that this workflow was locked. More...

string	LockStatus `[get]`
	Gets a string describing the current lock status of this workflow. More...

new string	Name `[get, set]`
	Gets or sets a string containing the name of this workflow. More...

string	NormalRect `[get, set]`
	Gets or sets the Workflow's normal view window size and position information. More...

string	OutlineRect `[get, set]`
	Gets or sets the Workflow's outline view window size and position information. 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...

int	PercentageCompleted `[get]`
	Gets the percentage value (00~100) indicating where the workflow progress is up to 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 when creating documents during the workflow progress. More...

TrimDateTime	ScheduledStartDate `[get, set]`
	Gets or sets a datetime property indicating when the workflow is scheduled to start. More...

Location?	Supervisor `[get, set]`
	Gets or sets the Location object which is the supervisor of this workflow. The supervisor is responsible for overseeing the progress and completion of the Workflow. More...

WorkflowTemplate?	Template `[get]`
	Gets the template object used to initiate this workflow, upon which its design is based. More...

TrimCurrency	TotalActualCost `[get]`
	Gets a currency value indicating total actual cost of this workflow. More...

long	TotalActualDuration `[get]`
	Gets an integer value indicating total actual time spent on this workflow (in seconds). More...

TrimCurrency	TotalEstimatedCost `[get]`
	Gets a currency value indicating total estimated cost of this workflow. More...

long	TotalEstimatedDuration `[get]`
	Gets an integer value indicating total estimated duration of this workflow (in seconds). More...

long	TotalRemainingDuration `[get]`
	Gets an integer value indicating total estimated duration of all the incompleted activities in this workflow (in seconds). More...

Priority	WorkflowPriority `[get, set]`
	Gets or sets a piPriority enum value indicating the priority of this workflow. More...

WorkflowDocuments	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]`

Properties inherited from TRIM.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...

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...

Detailed Description

A workflow is a structured set of activities that need to be completed according to a set sequence

Constructor & Destructor Documentation

◆ Workflow() [1/3]

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

◆ Workflow() [2/3]

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

◆ Workflow() [3/3]

TRIM.SDK.Workflow.Workflow ( Database database )

Member Function Documentation

◆ AddToFavorites()

void TRIM.SDK.Workflow.AddToFavorites ( )

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

Implements TRIM.SDK.ITrimLabels.

◆ ApplyUserLabel()

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

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

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinFavorites()

bool TRIM.SDK.Workflow.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.Workflow.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.Workflow.DetachUserLabel ( UserLabel userLabelToDetach )

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

Implements TRIM.SDK.ITrimLabels.

◆ FindActivityById()

Activity TRIM.SDK.Workflow.FindActivityById	(	int	lookForActivityID,
		bool	searchRecursively
	)

◆ FindActivityByName()

Activity TRIM.SDK.Workflow.FindActivityByName	(	string	name,
		bool	searchRecursively
	)

◆ GetActivity()

Activity TRIM.SDK.Workflow.GetActivity ( int activityIndex )

◆ GetFieldValue()

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

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

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.Workflow.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.

◆ Lock()

void TRIM.SDK.Workflow.Lock ( )

◆ NewActivity()

Activity TRIM.SDK.Workflow.NewActivity ( )

◆ RemoveFromFavorites()

void TRIM.SDK.Workflow.RemoveFromFavorites ( )

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

Implements TRIM.SDK.ITrimLabels.

◆ SetFieldValue()

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

◆ Unlock()

void TRIM.SDK.Workflow.Unlock ( )

Property Documentation

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.Workflow.AccessControlList

getset

◆ ActivityCount

int TRIM.SDK.Workflow.ActivityCount

get

◆ AutoStartActivities

bool TRIM.SDK.Workflow.AutoStartActivities

getset

Gets or sets a boolean value indicating whether activities should be automatically started when they are ready to start.

◆ CanAddToNotes

bool TRIM.SDK.Workflow.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.Workflow.CanModifyExistingNotes

get

◆ ChildDocuments

WorkflowDocuments TRIM.SDK.Workflow.ChildDocuments

get

Get the list of Documents

◆ Creator

Location? TRIM.SDK.Workflow.Creator

get

Gets the location who initially created this workflow.

◆ Customer

Location? TRIM.SDK.Workflow.Customer

getset

Gets or sets the Location object which is the customer for this workflow.

◆ DateCompleted

TrimDateTime TRIM.SDK.Workflow.DateCompleted

get

Gets the date this workflow was completed, if it has been completed.

◆ DateDue

TrimDateTime TRIM.SDK.Workflow.DateDue

getset

Gets or sets the date this workflow is due for completion.

◆ DateRegistered

TrimDateTime TRIM.SDK.Workflow.DateRegistered

get

Gets the date this workflow was registered in Content Manager.

◆ DateStarted

TrimDateTime TRIM.SDK.Workflow.DateStarted

get

Gets the date this workflow was started in Content Manager.

◆ DefaultContainer

Record? TRIM.SDK.Workflow.DefaultContainer

getset

Gets or sets the Record object which is the default container for this workflow. This is used to contain any new records attached to the Workflow as Workflow Documents.

◆ DestroyDueDate

TrimDateTime TRIM.SDK.Workflow.DestroyDueDate

getset

Gets the date this workflow is due for destruction.

◆ EmailSupervisor

bool TRIM.SDK.Workflow.EmailSupervisor

getset

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

◆ Incomplete

bool TRIM.SDK.Workflow.Incomplete

get

Gets a Boolean value indicating whether this workflow is incomplete.

◆ InitialAssignee

Location? TRIM.SDK.Workflow.InitialAssignee

get

Gets the Location object which is the assignee of the first activity in this workflow.

◆ Initiator

Record? TRIM.SDK.Workflow.Initiator

getset

Gets or sets the Record object by which this workflow process was initiated.

◆ IsComplete

bool TRIM.SDK.Workflow.IsComplete

get

Gets a Boolean value indicating whether this workflow is complete.

◆ IsOverdue

bool TRIM.SDK.Workflow.IsOverdue

get

Gets a Boolean value indicating whether this workflow is overdue.

◆ JobNumber

string TRIM.SDK.Workflow.JobNumber

getset

Gets or sets a string containing the job number for this workflow. This is an automatically generated number of the numbering pattern: 'YYYY/GGGGG'.

◆ JobNumberExpanded

string TRIM.SDK.Workflow.JobNumberExpanded

getset

Gets a string containing the job number for this workflow. This is an automatically generated number of the numbering pattern: 'YYYY/GGGGG'.

◆ LockedBy

Location? TRIM.SDK.Workflow.LockedBy

get

Gets the location object that currently has this workflow locked.

◆ LockedOn

TrimDateTime TRIM.SDK.Workflow.LockedOn

get

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

◆ LockStatus

string TRIM.SDK.Workflow.LockStatus

get

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

◆ Name

new string TRIM.SDK.Workflow.Name

getset

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

◆ NormalRect

string TRIM.SDK.Workflow.NormalRect

getset

Gets or sets the Workflow's normal view window size and position information.

◆ Notes

string TRIM.SDK.Workflow.Notes

getset

◆ OutlineRect

string TRIM.SDK.Workflow.OutlineRect

getset

Gets or sets the Workflow's outline view window size and position information.

◆ OverheadCost

TrimCurrency TRIM.SDK.Workflow.OverheadCost

getset

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

◆ PercentageCompleted

int TRIM.SDK.Workflow.PercentageCompleted

get

Gets the percentage value (00~100) indicating where the workflow progress is up to

◆ RecalcWhenFinishEarly

bool TRIM.SDK.Workflow.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.

◆ RecalcWhenFinishLate

bool TRIM.SDK.Workflow.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.

◆ RecalcWhenSuspended

bool TRIM.SDK.Workflow.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

RecordType? TRIM.SDK.Workflow.RecordType

getset

Gets or sets the RecordType object which will be used as default record type when creating documents during the workflow progress.

◆ ScheduledStartDate

TrimDateTime TRIM.SDK.Workflow.ScheduledStartDate

getset

Gets or sets a datetime property indicating when the workflow is scheduled to start.

◆ Supervisor

Location? TRIM.SDK.Workflow.Supervisor

getset

Gets or sets the Location object which is the supervisor of this workflow. The supervisor is responsible for overseeing the progress and completion of the Workflow.

◆ Template

WorkflowTemplate? TRIM.SDK.Workflow.Template

get

Gets the template object used to initiate this workflow, upon which its design is based.

◆ TotalActualCost

TrimCurrency TRIM.SDK.Workflow.TotalActualCost

get

Gets a currency value indicating total actual cost of this workflow.

◆ TotalActualDuration

long TRIM.SDK.Workflow.TotalActualDuration

get

Gets an integer value indicating total actual time spent on this workflow (in seconds).

◆ TotalEstimatedCost

TrimCurrency TRIM.SDK.Workflow.TotalEstimatedCost

get

Gets a currency value indicating total estimated cost of this workflow.

◆ TotalEstimatedDuration

long TRIM.SDK.Workflow.TotalEstimatedDuration

get

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

◆ TotalRemainingDuration

long TRIM.SDK.Workflow.TotalRemainingDuration

get

Gets an integer value indicating total estimated duration of all the incompleted activities in this workflow (in seconds).

◆ WorkflowPriority

Priority TRIM.SDK.Workflow.WorkflowPriority

getset

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Workflow() [1/3]

◆ Workflow() [2/3]

◆ Workflow() [3/3]

Member Function Documentation

◆ AddToFavorites()

◆ ApplyUserLabel()

◆ ChangePositionWithinFavorites()

◆ ChangePositionWithinUserLabel()

◆ DetachUserLabel()

◆ FindActivityById()

◆ FindActivityByName()

◆ GetActivity()

◆ GetFieldValue()

◆ GetFieldValueAsString()

◆ Lock()

◆ NewActivity()

◆ RemoveFromFavorites()

◆ SetFieldValue()

◆ SetNotes()

◆ Unlock()

Property Documentation

◆ AccessControlList

◆ ActivityCount

◆ AutoStartActivities

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ ChildDocuments

◆ Creator

◆ Customer

◆ DateCompleted

◆ DateDue

◆ DateRegistered

◆ DateStarted

◆ DefaultContainer

◆ DestroyDueDate

◆ EmailSupervisor

◆ Incomplete

◆ InitialAssignee

◆ Initiator

◆ IsComplete

◆ IsOverdue

◆ JobNumber

◆ JobNumberExpanded

◆ LockedBy

◆ LockedOn

◆ LockStatus

◆ Name

◆ NormalRect

◆ Notes

◆ OutlineRect

◆ OverheadCost

◆ PercentageCompleted

◆ RecalcWhenFinishEarly

◆ RecalcWhenFinishLate

◆ RecalcWhenSuspended

◆ RecordType

◆ ScheduledStartDate

◆ Supervisor

◆ Template

◆ TotalActualCost

◆ TotalActualDuration

◆ TotalEstimatedCost

◆ TotalEstimatedDuration

◆ TotalRemainingDuration

◆ WorkflowPriority