Class icm.model.LaunchStep

Extends ecm.model._ModelObject.
Represents the launch step of a workflow when creating a new (discretionary) task. For a launch step, the parameters of the step are exposed as the properties collection of this object
Defined in: <icm/model/LaunchStep.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.model.LaunchStep(properties) Constructs a LaunchStep object.

Field Summary

Field Attributes	Field Name and Description
	authoredMapName The authored workflow map name.
	comment The comment of the launch step.
	externalDataIdentifier Will be non-null if integrating with an external data service
	instruction The instruction for the launch step.
	mapName The workflow map name
	propertiesCollection The collection of PropertyEditable objects that represent the step parameters of this launch step.
	responses The possible step responses.
	selectedResponse The currently selected step response.
	stepId The Id of the launch step.
	stepName The name of the launch step.
	subject The subject of the launch step.
	taskEditable The TaskEditable object that this LaunchStep object is coupled to.
	workflowName The workflow name.
	workObjectNumber The work object number.

Method Summary

Method Attributes	Method Name and Description
	getCase() Returns the Case object associated with the new TaskEditable of this LaunchStep.
	getCaseType() Returns the CaseType object for the Case associated with the new TaskEditable of this LaunchStep.
	getProperty(provider, symbolicName) Obtains the PropertyEditable from the propertiesCollection property with the given provider and symbolic name.
	isDependentPropertiesRetrievalPending() Indicates if retrieveDependentProperties() should be called to resolve dependent properties on the server.
	retrieveAllAttachmentContents(callback) Retrieves all attachment contents of all attachment fields at once.
	retrieveDependentProperties(callback, errCallback, backgroundRequest) Resolves dependent properties with the server.
	setComment(commentText) Sets the comment of the launch step.
	setSelectedResponse(response) Sets the step response.
	setSubject(subject) Sets the subject of the launch step.

Constructor Detail

icm.model.LaunchStep(properties)

Constructs a LaunchStep object. A LaunchStep object is typically constructed internally by other model objects.

Parameters:
properties: The properties for the LaunchStep object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

authoredMapName

The authored workflow map name.

comment

The comment of the launch step.

externalDataIdentifier

Will be non-null if integrating with an external data service

instruction

The instruction for the launch step.

mapName

The workflow map name

propertiesCollection

The collection of PropertyEditable objects that represent the step parameters of this launch step.

responses

The possible step responses.

selectedResponse

The currently selected step response.

stepId

The Id of the launch step.

stepName

The name of the launch step.

subject

The subject of the launch step.

taskEditable

The TaskEditable object that this LaunchStep object is coupled to.

workflowName

The workflow name.

workObjectNumber

The work object number.

Method Detail

getCase()

Returns the Case object associated with the new TaskEditable of this LaunchStep.

Returns:: An icm.model.Case object

getCaseType()

Returns the CaseType object for the Case associated with the new TaskEditable of this LaunchStep.

Returns:: An icm.model.CaseType object

getProperty(provider, symbolicName)

Obtains the PropertyEditable from the propertiesCollection property with the given provider and symbolic name. The PropertyEditable objects in propertiesCollection are keyed by the id of each PropertyEditable. In some cases that id could be different from the symbolic name. This method is a shortcut to find the appropriate property object.

Parameters:
provider
symbolicName

Returns:: PropertyEditable object if one exists with the given provider and symbolic name. Otherwise null.

isDependentPropertiesRetrievalPending()

Indicates if retrieveDependentProperties() should be called to resolve dependent properties on the server. This method returns true if any PropertyEditable objects in the properties collection have their dependentsRetrievalPending property set to true.

Returns:: (boolean) True if any dependents retrieval is pending.

retrieveAllAttachmentContents(callback)

Retrieves all attachment contents of all attachment fields at once. Calling this method will optimize the call to retrieve the ContentItem objects associated with each PropertyEditable object that can be more efficient than calling the retrieveAttachmentContents() method of each PropertyEditable object individually.

Parameters:
callback: Callback function called with this LaunchStep object as an argument when the request completes.

retrieveDependentProperties(callback, errCallback, backgroundRequest)

Resolves dependent properties with the server. This method should be called whenever the value of a PropertyEditable object is modified and that property has the hasDependentProperties property set to true.

Parameters:
callback: Callback function called with this LaunchStep object as an argument when the request completes.
errCallback: An optional argument. A function called if the request fails.
backgroundRequest: An optional argument. If true, indicates the request is processed in the background.

setComment(commentText)

Sets the comment of the launch step.

Parameters:
commentText: the text of the comment

setSelectedResponse(response)

Sets the step response.

Parameters:
response: the step response

setSubject(subject)

Sets the subject of the launch step.

Parameters:
subject: the subject text