Package com.pnfsoftware.jeb.core.actions

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 Summary

Fields

Modifier and Type	Field	Description
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).

Fields inherited from class com.pnfsoftware.jeb.core.actions.ActionData

ERRCODE_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ActionRenameData()

Method Summary

Modifier and Type	Method	Description
boolean	canReuseObject()	Determine whether this payload instance may be reused after reset().
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 client-provided rename inputs and transient execution data.
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.

Methods inherited from class com.pnfsoftware.jeb.core.actions.ActionData

getDescription, getExecutionErrorCode, getExecutionErrorMessage, getValue, isNoInfoRequest, setDescription, setExecutionError, setExecutionErrorCode, setExecutionErrorMessage, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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:

• Constant Field Values

Constructor Details

ActionRenameData

public ActionRenameData()

Method Details

reset

public void reset()

Reset client-provided rename inputs and transient execution data.

Overrides:

reset in class ActionData

canReuseObject

public boolean canReuseObject()

Determine whether this payload instance may be reused after reset().

Overrides:

canReuseObject in class ActionData

Returns:

always true

getOriginalName

public String getOriginalName()

Get the original name. This method is used by clients.

Returns:

the original name, if known

setOriginalName

public void setOriginalName(String originalName)

Set the original name. This method is used by plugins.

Parameters:

originalName - original item name

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:

true if conflict checks may be bypassed when supported