com.prosyst.mprm.admin.operations

Interface PendingCommand

public interface PendingCommand

Represents single command pending for execution on a device. This interface provides more fine grained monitoring and control than the Operation interface, since one operation could consist of several commands and the set of commands in the operation could change during the execution. In addition this interface could be used to manage the commands which are not associated with an Operation object.

See Also:

OperationManager.executeOperation(java.lang.String contextPath, com.prosyst.mprm.commands.Command, boolean persistent)

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERPRETATION_NOT_STARTED Command is dispatched to the device, but not passed for interpreting, yet.
static int	INTERPRETATION_STARTED The command is sent to device for interpretation.
static int	OFFLINE_INTERPRETATION_RUNNING Command is sent to device for interpretation, and device has declared 'offline interpretation' for this command, meaning that system will not re-force the command on device reconnect.

Method Summary

Modifier and Type	Method and Description
Command	getCommand() Returns the command object.
int	getCommandState() Returns the exact state of the pending command.
java.lang.String	getDeviceId() Returns the id of the device which this command is pending for.
java.lang.String	getDeviceType() Returns the type of the device which this command is pending for.
java.lang.String	getOperationId() Returns the operation id which this command is associated with, or null if the command is not associated with the Operation object.
java.lang.String	getPendingCommandId() Returns the unique identifier of this pending command.
java.util.Dictionary<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String key)
void	setProperties(java.util.Dictionary<java.lang.String,java.lang.Object> properties)
void	setProperty(java.lang.String key, java.lang.Object value)

Field Detail

INTERPRETATION_NOT_STARTED

static final int INTERPRETATION_NOT_STARTED

Command is dispatched to the device, but not passed for interpreting, yet.

See Also:

Constant Field Values

INTERPRETATION_STARTED

static final int INTERPRETATION_STARTED

The command is sent to device for interpretation. Confirmation is waited.

See Also:

Constant Field Values

OFFLINE_INTERPRETATION_RUNNING

static final int OFFLINE_INTERPRETATION_RUNNING

Command is sent to device for interpretation, and device has declared 'offline interpretation' for this command, meaning that system will not re-force the command on device reconnect.

See Also:

Constant Field Values

Method Detail

getPendingCommandId

java.lang.String getPendingCommandId()

Returns the unique identifier of this pending command.

Returns:

command identifier

getDeviceType

java.lang.String getDeviceType()

Returns the type of the device which this command is pending for.

Returns:

device type.

getDeviceId

java.lang.String getDeviceId()

Returns the id of the device which this command is pending for.

Returns:

device id.

getOperationId

java.lang.String getOperationId()

Returns the operation id which this command is associated with, or null if the command is not associated with the Operation object.

Returns:

operation id.

getCommand

Command getCommand()

Returns the command object.

Returns:

the command.

getCommandState

int getCommandState()

Returns the exact state of the pending command.

Returns:

some of the integer constants defined - INTERPRETATION_NOT_STARTED, INTERPRETATION_STARTED or OFFLINE_INTERPRETATION_RUNNING.

getProperties

java.util.Dictionary<java.lang.String,java.lang.Object> getProperties()

setProperties

void setProperties(java.util.Dictionary<java.lang.String,java.lang.Object> properties)

getProperty

java.lang.Object getProperty(java.lang.String key)

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)