Inheritance diagram for TRIM.SDK.RecordChildAction:

Public Member Functions
void	SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)

void	Delete ()
	Permanently removes this object and all its associated child objects from the database. More...

RecordChildAction	AddAction (ActionDef actionOrProcedureDefinition, Location defaultAssignee, bool overrideExistingAssignee, bool insertBefore)
	Add the pre-defined action or procedure either before or after this action More...

	RecordChildAction ()

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	Name `[get]`
	Gets or sets the name of this record action More...

TrimURI	Uri `[get]`
	Gets the uri of this record action. Note that for recordChildAction objects, uris are pre-allocated before being committed More...

bool	CanModifyExistingNotes `[get]`
	gets or sets More...

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

RecordChildActions?	ProcedureItems `[get]`
	Gets a list of subordinate actions if this action is a procedure More...

string	ActionName `[get]`
	Gets a string value which is the name of the record action. More...

int	ActualDays `[get]`
	Gets or sets a number indicating the number of days portion of the actual duration of this action. More...

string	ActualDuration `[get]`
	Gets a string that displays a formatted version of the actual duration. More...

int	ActualHours `[get]`
	Gets or sets a number indicating the number of hours portion of the actual duration of this action. More...

int	ActualMinutes `[get]`
	Gets or sets a number indicating the number of minutes portion of the actual duration of this action. More...

Location?	AssignedBy `[get]`
	Gets a location object representing the user responsible for allocating the current assignee for this action. More...

TrimDateTime	AttachDate `[get]`
	Gets a date and time when this action was attached to its record. More...

string	Barcode `[get]`
	Gets a string that is a barcode representing this record action. More...

Location?	CompletedBy `[get]`
	Gets a location object representing the person responsible for actually completing this action. More...

bool	CompletedOnTime `[get]`
	Gets a boolean value indicating whether this action has been completed and was completed before the due date. More...

TrimCurrency	Cost `[get, set]`
	Gets or sets a currency value indicating the estimated cost of completing this action. More...

int	Days `[get, set]`
	Gets or sets a number indicating the number of days portion of the estimated duration of this action. More...

bool	Done `[get]`
	Gets a boolean value indicating whether this record action has been completed. More...

TrimDateTime	DueDate `[get, set]`
	Gets or sets a date and time when this action is meant to be completed. More...

string	Duration `[get]`
	Gets a string that displays a formatted version of the estimated duration. More...

TrimDateTime	EndDate `[get, set]`
	Gets or sets a date and time indicating that this action is complete. If you wish to un-complete the action, pass a blank date. More...

int	Hours `[get, set]`
	Gets or sets a number indicating the number of hours portion of the estimated duration of this action. More...

string	Instructions `[get]`
	Gets a string containing any instructions regarding this record action. More...

bool	IsReadyToStart `[get]`
	Gets a boolean value indicating whether this action is ready to be started. More...

bool	LockDates `[get, set]`
	Gets or sets a boolean property indicating that, for this action, any calculated start and due dates will not be modified by any rescheduling operation. More...

int	Minutes `[get, set]`
	Gets or sets a number indicating the number of minutes portion of the estimated duration of this action. More...

bool	Overdue `[get]`
	Gets a boolean value indicating whether this record action is currently overdue. More...

RecordChildAction?	ParentRecordAction `[get]`
	Gets a uri value for the parent action of this record action if it is step within a procedure. More...

int	PercentComplete `[get]`
	Gets a number indication the percentage of the work on this action that has been completed. More...

bool	Procedure `[get]`
	Gets a boolean value indicating whether this record action is part of a record action procedure. More...

Record?	Record `[get]`
	Gets the record object associated with this record action. More...

Location?	Responsibility `[get, set]`
	Gets or sets the location object representing the person assigned to performing this action. More...

TrimDateTime	StartDate `[get]`
	Gets a date and time when this action was meant to be started. More...

string	Status `[get]`
	Gets a string value describing the current status of this record action. More...

TrimDateTime	SuspendUntil `[get, set]`
	Gets or sets a date and time that indicates the date until this action is suspended until. Pass a blank date if the action is ready to resume. More...

bool	Viewable `[get]`
	Gets a boolean property indicating if the current user has access rights to view the metadata of the record associated with this record action. More...

bool	IsNew `[get]`
	Gets a boolean property indicating if this action has been newly added and is not yet committed to the database by a Save to the parent record. Child actions have pre-allocated uris, so it is not possible to know if an action has been committed by examining the Uri property. 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...

Constructor & Destructor Documentation

◆ RecordChildAction()

TRIM.SDK.RecordChildAction.RecordChildAction ( )

Member Function Documentation

◆ AddAction()

RecordChildAction TRIM.SDK.RecordChildAction.AddAction	(	ActionDef	actionOrProcedureDefinition,
		Location	defaultAssignee,
		bool	overrideExistingAssignee,
		bool	insertBefore
	)

Add the pre-defined action or procedure either before or after this action

◆ Delete()

void TRIM.SDK.RecordChildAction.Delete ( )

Permanently removes this object and all its associated child objects from the database.

◆ SetNotes()

void TRIM.SDK.RecordChildAction.SetNotes	(	string	newValue,
		NotesUpdateType	TypeOfNotesUpdate
	)

Property Documentation

◆ ActionName

string TRIM.SDK.RecordChildAction.ActionName

get

Gets a string value which is the name of the record action.

◆ ActualDays

int TRIM.SDK.RecordChildAction.ActualDays

get

Gets or sets a number indicating the number of days portion of the actual duration of this action.

◆ ActualDuration

string TRIM.SDK.RecordChildAction.ActualDuration

get

Gets a string that displays a formatted version of the actual duration.

◆ ActualHours

int TRIM.SDK.RecordChildAction.ActualHours

get

Gets or sets a number indicating the number of hours portion of the actual duration of this action.

◆ ActualMinutes

int TRIM.SDK.RecordChildAction.ActualMinutes

get

Gets or sets a number indicating the number of minutes portion of the actual duration of this action.

◆ AssignedBy

Location? TRIM.SDK.RecordChildAction.AssignedBy

get

Gets a location object representing the user responsible for allocating the current assignee for this action.

◆ AttachDate

TrimDateTime TRIM.SDK.RecordChildAction.AttachDate

get

Gets a date and time when this action was attached to its record.

◆ Barcode

string TRIM.SDK.RecordChildAction.Barcode

get

Gets a string that is a barcode representing this record action.

◆ CanAddToNotes

bool TRIM.SDK.RecordChildAction.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.RecordChildAction.CanModifyExistingNotes

get

gets or sets

◆ CompletedBy

Location? TRIM.SDK.RecordChildAction.CompletedBy

get

Gets a location object representing the person responsible for actually completing this action.

◆ CompletedOnTime

bool TRIM.SDK.RecordChildAction.CompletedOnTime

get

Gets a boolean value indicating whether this action has been completed and was completed before the due date.

◆ Cost

TrimCurrency TRIM.SDK.RecordChildAction.Cost

getset

Gets or sets a currency value indicating the estimated cost of completing this action.

◆ Days

int TRIM.SDK.RecordChildAction.Days

getset

Gets or sets a number indicating the number of days portion of the estimated duration of this action.

◆ Done

bool TRIM.SDK.RecordChildAction.Done

get

Gets a boolean value indicating whether this record action has been completed.

◆ DueDate

TrimDateTime TRIM.SDK.RecordChildAction.DueDate

getset

Gets or sets a date and time when this action is meant to be completed.

◆ Duration

string TRIM.SDK.RecordChildAction.Duration

get

Gets a string that displays a formatted version of the estimated duration.

◆ EndDate

TrimDateTime TRIM.SDK.RecordChildAction.EndDate

getset

Gets or sets a date and time indicating that this action is complete. If you wish to un-complete the action, pass a blank date.

◆ Hours

int TRIM.SDK.RecordChildAction.Hours

getset

Gets or sets a number indicating the number of hours portion of the estimated duration of this action.

◆ Instructions

string TRIM.SDK.RecordChildAction.Instructions

get

Gets a string containing any instructions regarding this record action.

◆ IsNew

bool TRIM.SDK.RecordChildAction.IsNew

get

Gets a boolean property indicating if this action has been newly added and is not yet committed to the database by a Save to the parent record. Child actions have pre-allocated uris, so it is not possible to know if an action has been committed by examining the Uri property.

◆ IsReadyToStart

bool TRIM.SDK.RecordChildAction.IsReadyToStart

get

Gets a boolean value indicating whether this action is ready to be started.

◆ LockDates

bool TRIM.SDK.RecordChildAction.LockDates

getset

Gets or sets a boolean property indicating that, for this action, any calculated start and due dates will not be modified by any rescheduling operation.

◆ Minutes

int TRIM.SDK.RecordChildAction.Minutes

getset

Gets or sets a number indicating the number of minutes portion of the estimated duration of this action.

◆ Name

string TRIM.SDK.RecordChildAction.Name

get

Gets or sets the name of this record action

◆ Notes

string TRIM.SDK.RecordChildAction.Notes

getset

◆ Overdue

bool TRIM.SDK.RecordChildAction.Overdue

get

Gets a boolean value indicating whether this record action is currently overdue.

◆ ParentRecordAction

RecordChildAction? TRIM.SDK.RecordChildAction.ParentRecordAction

get

Gets a uri value for the parent action of this record action if it is step within a procedure.

◆ PercentComplete

int TRIM.SDK.RecordChildAction.PercentComplete

get

Gets a number indication the percentage of the work on this action that has been completed.

◆ Procedure

bool TRIM.SDK.RecordChildAction.Procedure

get

Gets a boolean value indicating whether this record action is part of a record action procedure.

◆ ProcedureItems

RecordChildActions? TRIM.SDK.RecordChildAction.ProcedureItems

get

Gets a list of subordinate actions if this action is a procedure

◆ Record

Record? TRIM.SDK.RecordChildAction.Record

get

Gets the record object associated with this record action.

◆ Responsibility

Location? TRIM.SDK.RecordChildAction.Responsibility

getset

Gets or sets the location object representing the person assigned to performing this action.

◆ StartDate

TrimDateTime TRIM.SDK.RecordChildAction.StartDate

get

Gets a date and time when this action was meant to be started.

◆ Status

string TRIM.SDK.RecordChildAction.Status

get

Gets a string value describing the current status of this record action.

◆ SuspendUntil

TrimDateTime TRIM.SDK.RecordChildAction.SuspendUntil

getset

Gets or sets a date and time that indicates the date until this action is suspended until. Pass a blank date if the action is ready to resume.

◆ Uri

TrimURI TRIM.SDK.RecordChildAction.Uri

get

Gets the uri of this record action. Note that for recordChildAction objects, uris are pre-allocated before being committed

◆ Viewable

bool TRIM.SDK.RecordChildAction.Viewable

get

Gets a boolean property indicating if the current user has access rights to view the metadata of the record associated with this record action.

Public Member Functions

Properties

Constructor & Destructor Documentation

◆ RecordChildAction()

Member Function Documentation

◆ AddAction()

◆ Delete()

◆ SetNotes()

Property Documentation

◆ ActionName

◆ ActualDays

◆ ActualDuration

◆ ActualHours

◆ ActualMinutes

◆ AssignedBy

◆ AttachDate

◆ Barcode

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ CompletedBy

◆ CompletedOnTime

◆ Cost

◆ Days

◆ Done

◆ DueDate

◆ Duration

◆ EndDate

◆ Hours

◆ Instructions

◆ IsNew

◆ IsReadyToStart

◆ LockDates

◆ Minutes

◆ Name

◆ Notes

◆ Overdue

◆ ParentRecordAction

◆ PercentComplete

◆ Procedure

◆ ProcedureItems

◆ Record

◆ Responsibility

◆ StartDate

◆ Status

◆ SuspendUntil

◆ Uri

◆ Viewable