Topics
Prev Next

Functions - Validate and Control User Input

Enterprise Architect calls a number of functions to validate and control user input. For each function a set of objects is filled.

Validate/Control User Input

Function

Action

AllowPhaseUpdate(OldValue,
NewValue)

Validate a change a user has made to a phase.

Return Value:

  • True to allow this user to make this change
  • False to disallow the change and revert to the previous value

AllowStatusUpdate(OldValue,
NewValue)

Validate a change a user has made to a status.

Return Value:

  • True to allow this user to make this change
  • False to disallow the change and revert to the previous value

AllowTagUpdate(TagName,
OldValue,
NewValue)

Validate a change a user has made to a Tagged Value.

Return Value:

  • True to allow this user to make this change
  • False to disallow the change and revert to the previous value

AllowVersionUpdate(OldValue,
NewValue)

Validate a change a user has made to a version.

Return Value:

  • True to allow this user to make this change
  • False to disallow the change and revert to the previous value

CanEditPhase()

Enable or disable the control for editing a phase

Return Value:

  • True to allow this user to make changes by enabling the control
  • False to completely disable edit of this property by disabling the control

CanEditStatus()

Enable or disable the control for editing a status.

Return Value:

  • True to allow this user to make changes by enabling the control
  • False to completely disable edit of this property by disabling the control

CanEditTag(TagName)

Enable or disable the control for editing a Tagged Value.

Return Value:

  • True to allow this user to make changes by enabling the control
  • False to completely disable edit of this property by disabling the control

CanEditVersion()

Enable or disable the control for editing a version.

Return Value:

  • True to allow this user to make changes by enabling the control
  • False to completely disable edit of this property by disabling the control

OnPreNewElement(ElementType,
ElementStereotype)

Allow or disallow the creation of the specified element.

Return Value:

  • True to allow this user to create the element/connector
  • False to prevent this user from creating the element

OnPreNewConnector(ConnectorType,
ConnectorSubType,
ConnectorStereotype)

Allow or disallow the creation of the specified connector.

Return Value:

  • True to allow this user to create the element/connector
  • False to prevent this user from creating the element

PreAllowPhaseUpdate(OldValue,
NewValue)

Determine what information is required to validate this change.

Return Value: Semi-colon separated list of additional data required in order to validate this change.

Supported Data Type:

  • Tests - fill the Tests array in the WorkflowContext object

PreAllowStatusUpdate(OldValue,
NewValue)

Determine what information is required to validate this change.

Return Value: Semi-colon separated list of additional data required in order to validate this change.

Supported Data Type:

Tests - fill the Tests array in the WorkflowContext object

PreAllowTagUpdate(TagName,
OldValue,
NewValue)

Determine what information is required to validate this change.

Return Value: Semi-colon separated list of additional data required in order to validate this change.

Supported Data Type:

Tests - fill the Tests array in the WorkflowContext object

PreAllowVersionUpdate(OldValue,
NewValue)

Determine what information is required to validate this change.

Return Value: Semi-colon separated list of additional data required in order to validate this change.

Supported Data Type:

Tests - fill the Tests array in the WorkflowContext object

Learn more