commonj.connector.metadata.discovery.mutable
Interface Action


Deprecated. since 1.1

public interface Action

Simple action taken at steps in an Object Wizard. The implementation should carry any state to complete the action. Actions allow the user to proceed from one step in the wizard to the next step. If the status of the object wizard is not CANCEL or FINISH, there must be a CANCEL option along with at least one other action to walk the user through the wizard. CANCEL allows the user to cancel the operation.

Since:
1.0
See Also:
ObjectWizard.getNextStep(Action)

Method Summary
 String getDisplayName()
          Deprecated. Gets the "displayName" attribute.
 boolean isDisabled()
          Deprecated. This is used to indicate to the tool whether an action is disabled or not.
 

Method Detail

getDisplayName

String getDisplayName()
Deprecated. 
Gets the "displayName" attribute. This should never return null. Name that will appear on the GUI.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
String Returns the display name. null must never be returned.
See Also:
ResourceBundle, MessageFormat

isDisabled

boolean isDisabled()
Deprecated. 
This is used to indicate to the tool whether an action is disabled or not. This is provided so that an action may be disabled until a user enters required properties on the object wizard step. This function must always return false for the cancel operation.

The check for whether the action is disabled or not must be made on the currently applied properties for the object wizard step. this function may be called multiple times and hence it is recommended that the implementation of this function be efficient.

Returns:
boolean Flag to indicate if the actions is disabled or not. The cancel operation must always return false.
See Also:
ObjectWizardStep.applyProperties(PropertyGroup)