Package com.pnfsoftware.jeb.core.actions

Class ActionData

java.lang.Object
com.pnfsoftware.jeb.core.actions.ActionData
All Implemented Interfaces:
IActionData
Direct Known Subclasses:
ActionAutoRenameAllData, ActionCollapseData, ActionCommentData, ActionConvertData, ActionCreatePackageData, ActionDeleteData, ActionMoveToData, ActionMoveToPackageData, ActionOverridesData, ActionRenameData, ActionReplaceData, ActionSetTypeData, ActionTypeHierarchyData, ActionXrefsData
public class ActionData extends Object implements IActionData
Base implementation for action payload objects.

This class provides common support for execution errors, reusable scratch values, and optional descriptive text.

  • Field Details

    • ERRCODE_UNKNOWN

      public static final int ERRCODE_UNKNOWN
      The error code 0 means that no error code was set-up. Meaningful error codes must be non-zero, and are defined within specific action data classes (sub-classes of this class).
      See Also:

  • Constructor Details

    • ActionData

      public ActionData()
      Create an action payload with the default information-request behavior.

    • ActionData

      public ActionData(boolean hintNoInfoRequest)
      Create an action payload.
      Parameters:
      hintNoInfoRequest - if true, hints that only minimal preparation data is needed because the client intends to execute the action regardless of the current state

  • Method Details

    • isNoInfoRequest

      public boolean isNoInfoRequest()
      Determine whether the client requested a minimal preparation pass.
      Returns:
      true if only minimal action information should be prepared

    • reset

      public void reset()
      Reset this action data object. Sub-classes should override this method and invoke it as well.

    • canReuseObject

      public boolean canReuseObject()
      Determine whether this action data object may be safely reused after a reset() invocation.
      Returns:
      true if the object can be reused after being reset

    • setDescription

      public void setDescription(String description)
      Set the description string to be provided to the clients. To be used by plugins.
      Parameters:
      description - a human-readable description for the action state

    • getDescription

      public String getDescription()
      Retrieve the description string provided by the plugins. To be used by clients.
      Returns:
      the description string, or null if none was provided

    • setExecutionError

      public void setExecutionError(int code, String msg)
      The plugin may set an execution error code and message on a failed executeAction() invocation.
      Parameters:
      code - non-zero error code
      msg - optional error message

    • setExecutionErrorCode

      public void setExecutionErrorCode(int code)
      The plugin may set an execution error code on a failed executeAction() invocation.
      Parameters:
      code - non-zero error code

    • getExecutionErrorCode

      public int getExecutionErrorCode()
      The client may retrieve the optionally-set execution error code after a failed call to executeAction()
      Returns:
      the execution error code, or ERRCODE_UNKNOWN if none was provided

    • setExecutionErrorMessage

      public void setExecutionErrorMessage(String msg)
      The plugin may set an execution error message on a failed executeAction() invocation.
      Parameters:
      msg - optional error message

    • getExecutionErrorMessage

      public String getExecutionErrorMessage()
      The client may retrieve the optionally-set execution error message after a failed call to executeAction()
      Returns:
      the execution error message, or null if none was provided

    • getValue

      public Object getValue(String key)
      Retrieve an arbitrary object associated with a key.
      Specified by:
      getValue in interface IActionData
      Parameters:
      key - object key
      Returns:
      the stored object, or null

    • setValue

      public void setValue(String key, Object value)
      Store an arbitrary object associated with a key.
      Specified by:
      setValue in interface IActionData
      Parameters:
      key - object key
      value - object value