Class ecm.widget.SuspendWorkItems

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

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	constructor(cArgs)
	getSuspendForDurationUnits() Returns a string value of the suspend for duration units selection field.
	getSuspendForDurationValue() Returns a string value of the suspend for duration selection field.
	getSuspendOptionValue() Returns the string value of the suspend option selection field.
	getSuspendUntilDateValue() Returns a string holding the value of the suspend until date selection field.
	isAllInputValid() Returns `true` if all the specified workflow information is valid.
	onDateValueChanged() An event function called when the date value options have changed.
	onDurationValueChanged() An event function called when the duration options have changed.
	onInputChange() An event function called when some input fields have changed.
	onSuspendOptionChanged() An event function called when the suspend options have changed.
	postCreate()
	setItems(items) Sets an array of items to be suspended on a Content Manager workflow.
	setRepository(repository) Sets the repository to use for suspending the items.

Constructor Detail

ecm.widget.SuspendWorkItems()

Method Detail

constructor(cArgs)

Parameters:
cArgs

{String} getSuspendForDurationUnits()

Returns a string value of the suspend for duration units selection field.

Returns:: {String} holding the value of the suspend for duration units selection field.

{String} getSuspendForDurationValue()

Returns a string value of the suspend for duration selection field.

Returns:: {String} holding the value of the suspend for duration selection field.

{String} getSuspendOptionValue()

Returns the string value of the suspend option selection field.

Returns:: {String} holding the value of the suspend option selection field.

{String} getSuspendUntilDateValue()

Returns a string holding the value of the suspend until date selection field.

Returns:: {String} holding the value of the suspend until date selection field.

{Boolean} isAllInputValid()

Returns true if all the specified workflow information is valid.

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

onDateValueChanged()

An event function called when the date value options have changed.

onDurationValueChanged()

An event function called when the duration options have changed.

onInputChange()

An event function called when some input fields have changed.

onSuspendOptionChanged()

An event function called when the suspend options have changed.

postCreate()

setItems(items)

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

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

setRepository(repository)

Sets the repository to use for suspending the items.

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