public class

ActionContext

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.actions.ActionContext

Class Overview

Context of pre-execution and execution for an action. These objects are provided by a client (front-end) to the plugin (engines) when trying to:

  • verify execution: the client checks if an action execution can take place
  • prepare for execution: the client may provide pre-execution information, the engine will provide pre-execution information as well
  • execute an action: the client provides input data required by the plugin to perform the action
IInteractiveUnit process these objects in two ways.

See Also

Summary

Public Constructors
ActionContext(IInteractiveUnit unit, int actionId, long itemId)
Create an object, requesting action information for the provided item or provided address.
ActionContext(IInteractiveUnit unit, int actionId, long itemId, String address)
Create an object, requesting action information for the provided item or provided address.
ActionContext(IInteractiveUnit unit, int actionId, long itemId, String address, AddressConversionPrecision precision)
Create an object, requesting action information for the provided item or provided address.
Public Methods
int getActionId()
Get the action identifier.
String getAddress()
Get the address at which the action should take place.
AddressConversionPrecision getAddressPrecision()
long getItemId()
Get the item id of the object onto which the action should take place.
IInteractiveUnit getUnit()
Get the unit on to which the action is to be executed.
void setActionId(int actionId)
void setAddress(String address)
void setAddressPrecision(AddressConversionPrecision addressPrecision)
void setItemId(long itemId)
void setUnit(IInteractiveUnit unit)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ActionContext (IInteractiveUnit unit, int actionId, long itemId)

Create an object, requesting action information for the provided item or provided address.

Parameters
unit mandatory target unit
actionId mandatory action id
itemId optional item id (0 for none)

public ActionContext (IInteractiveUnit unit, int actionId, long itemId, String address)

Create an object, requesting action information for the provided item or provided address.

public ActionContext (IInteractiveUnit unit, int actionId, long itemId, String address, AddressConversionPrecision precision)

Create an object, requesting action information for the provided item or provided address.

Parameters
unit mandatory target unit
actionId mandatory action id
itemId optional item id (0 for none)
address optional address (null fo none)
precision precision of the address

Public Methods

public int getActionId ()

Get the action identifier.

Returns
  • the mandatory action identifier

public String getAddress ()

Get the address at which the action should take place.

Returns
  • the optional address, null if none

public AddressConversionPrecision getAddressPrecision ()

public long getItemId ()

Get the item id of the object onto which the action should take place.

Returns
  • the optional item id, 0 if none

public IInteractiveUnit getUnit ()

Get the unit on to which the action is to be executed.

Returns
  • the unit

public void setActionId (int actionId)

public void setAddress (String address)

public void setAddressPrecision (AddressConversionPrecision addressPrecision)

public void setItemId (long itemId)

public void setUnit (IInteractiveUnit unit)

public String toString ()