Class ecm.widget.process._PatternPropertiesMixin

Provides a mixin that defines methods for working with pattern workflow properties pane.
Defined in: <ecm\widget\process\_PatternPropertiesMixin.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	destroy()
	getPropertiesJSON() Returns the work item properties in a JSON format.
	isValid(focus, onEditStatus, onSaveStatus, response) Checks the work item properties list for having valid values.
	onChange()
	onCompleteRendering() An event function called after the widget is finished rendering.
	setFieldError(fieldName, errorMessage) Sets a properties field error state.
	setFieldFocus(fieldName) Sets a properties field focus state.

Constructor Detail

ecm.widget.process._PatternPropertiesMixin()

Since:: 2.0.2

Method Detail

destroy()

{Object} getPropertiesJSON()

Returns the work item properties in a JSON format.

Returns:: {Object} holding property data.

{Boolean} isValid(focus, onEditStatus, onSaveStatus, response)

Checks the work item properties list for having valid values.

Parameters:
focus
onEditStatus
onSaveStatus
response

Since:: 2.0.3.8 A boolean value indicating if the error field (if any) should be set as focus., 2.0.3.8 A boolean value indicating if we are editing the properties., 2.0.3.8 A boolean value indicating if we are saving the properties., 2.0.3.8 Contains the response when this validation is taking place as part of executing a workflow response.

Returns:: {Boolean} true if there are no validation errors, false otherwise.

onChange()

onCompleteRendering()

An event function called after the widget is finished rendering.

setFieldError(fieldName, errorMessage)

Sets a properties field error state.

Parameters:
fieldName: A string hold the field name.
errorMessage: A string hold the error message text to display.

setFieldFocus(fieldName)

Sets a properties field focus state.

Parameters:
fieldName: A string hold the field name.