Change Command State Programmatically

You need VLF EPC141006 (or later) to use this feature.

The #avFrameworkManager.avChangeCommandState method allows programmatic changing of a command's enablement state.

The associated event, avCommandStateChanged is signaled when the avChangeCommandState method successfully alters the enablement state of a command.

Refer to the shipped advanced example Command Enablement for more information.

Note: The changing of business object instance level command states within business objects that support multiple concurrently open instances is not viable because you cannot identify which open instance the state change applies to.    

Method: avChangeCommandState

Event: avCommandStateChanged

Parameters:

Name Usage Class Description

ObjectName

Input - Mandatory

Alpha – max length 32

Specifies the User Object Name/Type of the framework, application or business object to which the command belongs. An invalid name will cause a message to be displayed and the request will be ignored.

CommandName

Input – Mandatory

Alpha – max length 32

Specifies the User Object Name/Type of the command which is to have its state changed. An invalid name will cause a message to be displayed and the request will be ignored.

Enabled

Input - Mandatory

Boolean

Specifies whether the command is to now be enabled or disabled. If the command already has the requested state the request is ignored.

Signal (avChangeCommandState only)

Input - Optional

Boolean

Specifies whether the avCommandStateChanged event should be signaled. Default is true.