| java.lang.Object | ||
| ↳ | com.pnfsoftware.jeb.core.actions.ActionData | |
| ↳ | com.pnfsoftware.jeb.core.actions.ActionRenameData | |
Class Overview
This action class holds information for the RENAME action.
Unit plugins may support rename actions on items to allow clients to rename those items.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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). | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.pnfsoftware.jeb.core.actions.ActionData
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ActionRenameData() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
canReuseObject()
Determine whether this action data object may be safely reused after a
reset()
invocation. | ||||||||||
| String |
getCurrentName()
Get the current name.
| ||||||||||
| String |
getNewName()
Get the new name.
| ||||||||||
| String |
getOriginalName()
Get the original name.
| ||||||||||
| boolean |
isBypassNameChecks()
Plugins may retrieve this optional flag to determine whether naming conflict checks may be
bypassed, if it is possible.
| ||||||||||
| void |
reset()
Reset this action data object.
| ||||||||||
| 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.
| ||||||||||
| void |
setCurrentName(String name)
Set the current name.
| ||||||||||
| void |
setNewName(String name)
Set the new name.
| ||||||||||
| void |
setOriginalName(String originalName)
Set the original name.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.pnfsoftware.jeb.core.actions.ActionData
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.actions.IActionData
| |||||||||||
Constants
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).
Public Constructors
public ActionRenameData ()
Public Methods
public boolean canReuseObject ()
Determine whether this action data object may be safely reused after a reset()
invocation.
public String getCurrentName ()
Get the current name. This method is used by clients.
Returns
- the current name
public String getNewName ()
Get the new name. This method is used by plugins.
Returns
- the new name
public String getOriginalName ()
Get the original name. This method is used by clients.
public boolean isBypassNameChecks ()
Plugins may retrieve this optional flag to determine whether naming conflict checks may be bypassed, if it is possible.
public void reset ()
Reset this action data object. Sub-classes should override this method and invoke it as well.
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.
public void setCurrentName (String name)
Set the current name. This method is used by plugins.
Parameters
| name | current name |
|---|
public void setNewName (String name)
Set the new name. This method is used by clients.
Parameters
| name | new name |
|---|
public void setOriginalName (String originalName)
Set the original name. This method is used by plugins.