Class ecm.widget.StartWorkflow

Extends .
Provides a widget that is used to start folders and documents on an IBM Content Manager workflow.
Defined in: <ecm\widget\StartWorkflow.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.StartWorkflow()

Field Summary

Field Attributes	Field Name and Description
	workflowName A text string holding the name of the workflow to default the selection to
	workflowReadOnly A boolean setting that renders the workflow name selection control in readonly mode.

Method Summary

Method Attributes	Method Name and Description
	cleanup() Cleans up cached items.
	constructor(cArgs)
	getOwnerValue() Returns a string value of the workflow owner field.
	getPriorityValue() Returns a string value of the workflow priority field.
	getWorkflowValue() Returns a string value of the workflow selection field.
	isAllInputValid() Returns `true` if all of the specified workflow information is valid.
	onInputChange() An event function called when some input fields have changed.
	postCreate()
	setItems(items) Sets an array of items to be started on a Content Manager workflow.
	setRepository(repository) Sets the repository to use for starting the items on a workflow.

Constructor Detail

ecm.widget.StartWorkflow()

Field Detail

workflowName

A text string holding the name of the workflow to default the selection to

workflowReadOnly

A boolean setting that renders the workflow name selection control in readonly mode.

Method Detail

cleanup()

Cleans up cached items.

constructor(cArgs)

Parameters:
cArgs

{String} getOwnerValue()

Returns a string value of the workflow owner field.

Returns:: {String} A string value of the workflow owner field.

{String} getPriorityValue()

Returns a string value of the workflow priority field.

Returns:: {String} A string value of the workflow priority field.

{String} getWorkflowValue()

Returns a string value of the workflow selection field.

Returns:: {String} A string value of the workflow selection field.

{Boolean} isAllInputValid()

Returns true if all of the specified workflow information is valid.

Returns:: {Boolean} A value of true if all of the specified workflow information is valid, false otherwise.

onInputChange()

An event function called when some input fields have changed.

postCreate()

setItems(items)

Sets an array of items to be started on a Content Manager workflow.

Parameters:
items: An array of ecm.model.WorkItem objects.

setRepository(repository)

Sets the repository to use for starting the items on a workflow.

Parameters:
repository: Instance of ecm.model.Repository.