Class ActionRenameData

java.lang.Object
com.pnfsoftware.jeb.core.actions.ActionData
com.pnfsoftware.jeb.core.actions.ActionRenameData
All Implemented Interfaces:
IActionData

public class ActionRenameData extends ActionData
This action class holds information for the Actions.RENAME action.

Unit plugins may support rename actions on items to allow clients to rename those items.

  • Field Details

    • ERRCODE_NAMING_CONFLICT

      public static final int ERRCODE_NAMING_CONFLICT
      This error code may be set by plugins if the action failed because of a naming conflict (with naming conflict checks enforced).
      See Also:
  • Constructor Details

    • ActionRenameData

      public ActionRenameData()
  • Method Details

    • reset

      public void reset()
      Description copied from class: ActionData
      Reset this action data object. Sub-classes should override this method and invoke it as well.
      Overrides:
      reset in class ActionData
    • canReuseObject

      public boolean canReuseObject()
      Description copied from class: ActionData
      Determine whether this action data object may be safely reused after a ActionData.reset() invocation.
      Overrides:
      canReuseObject in class ActionData
      Returns:
    • getOriginalName

      public String getOriginalName()
      Get the original name. This method is used by clients.
      Returns:
    • setOriginalName

      public void setOriginalName(String originalName)
      Set the original name. This method is used by plugins.
      Parameters:
      originalName -
    • getCurrentName

      public String getCurrentName()
      Get the current name. This method is used by clients.
      Returns:
      the current name
    • setCurrentName

      public void setCurrentName(String name)
      Set the current name. This method is used by plugins.
      Parameters:
      name - current name
    • getNewName

      public String getNewName()
      Get the new name. This method is used by plugins.
      Returns:
      the new name
    • setNewName

      public void setNewName(String name)
      Set the new name. This method is used by clients.
      Parameters:
      name - new name
    • setBypassNameChecks

      public void setBypassNameChecks(boolean bypassNameConflictChecks)
      Clients may set this optional flag to let the plugin know that naming conflict checks may be bypassed, if it is possible.
      Parameters:
      bypassNameConflictChecks -
    • isBypassNameChecks

      public boolean isBypassNameChecks()
      Plugins may retrieve this optional flag to determine whether naming conflict checks may be bypassed, if it is possible.
      Returns: