Class ecm.widget.process._ProcessorMixin

Provides a mixin that defines methods for working with step processor meta data. This class creates the IBM FileNet P8 workflow response buttons. In addition, the class provides utility functions for working with filed data.
Defined in: <ecm\widget\process\_ProcessorMixin.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.process._ProcessorMixin()

Method Summary

Method Attributes	Method Name and Description
	addResponseButtons(processorButtonBar, separator, label) Creates the step responses buttons and inserts them into the button bar at bottom of page.
	destroy()
	getStringField(name, value, singleValue) Creates a value field for the specified property name.
	getSystemField(name, value) Creates a value field of type `system` for the specified property name.
	hasAttachment() Returns boolean `true` if there are any attachments are exposed on this work item.
	onDispatch() Calls `onOK` event handler of the implemented processor to save the property information and dispatch the work item.
	onResponse(response) Calls `onOK` event handler of the implemented processor to save the property information with specified response and dispatch the work item.

Constructor Detail

ecm.widget.process._ProcessorMixin()

Method Detail

addResponseButtons(processorButtonBar, separator, label)

Creates the step responses buttons and inserts them into the button bar at bottom of page. If there are no responses defined on this step, it will create the standard Complete button instead.

Parameters:
processorButtonBar: The ProcessorButtonBar to add the responses buttons to.
separator: A boolean flag for specifying whether to add a separator bar after the response buttons.
label: Text string to use as the default dispatch button label. The string is typically Launch or Complete.

destroy()

{Object} getStringField(name, value, singleValue)

Creates a value field for the specified property name.

Parameters:
name: A string holding the property name.
value: The value of the property.
singleValue

Returns:: {Object} holding string field meta data information.

{Object} getSystemField(name, value)

Creates a value field of type system for the specified property name.

Parameters:
name: A string holding the property name.
value: The value of the property.

Returns:: {Object} holding system field meta data information.

{Boolean} hasAttachment()

Returns boolean true if there are any attachments are exposed on this work item.

Returns:: {Boolean} true if there are any attachments are exposed on this work item, false otherwise.

onDispatch()

Calls onOK event handler of the implemented processor to save the property information and dispatch the work item.

onResponse(response)

Calls onOK event handler of the implemented processor to save the property information with specified response and dispatch the work item.

Parameters:
response: A string value of the selected response.