com.prosyst.mprm.backend.rules.spi

Interface AsyncResult

public interface AsyncResult

Represents object where method results could be provided asynchronously.

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.Throwable error) Sets the method execution is finished with error(s).
java.lang.String	getId() Unique identification of this AsyncResult object.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns custom properties assigned to this method execution represented by this AsyncResult object.
void	notReadyToExecute() Notifies the system that this method cannot be currently executed.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties, boolean append) Sets custom properties assigned to this method execution represented by this AsyncResult object.
void	success(java.lang.Object result) Sets the method execution as successfully complete and provides the execution result value if any.
void	warning(java.lang.String warningMessage) Sets the method execution is finished with warning(s).

Method Detail

getId

java.lang.String getId()

Unique identification of this AsyncResult object.

Returns:

id of this AsyncResult object.

success

void success(java.lang.Object result)

Sets the method execution as successfully complete and provides the execution result value if any. Using this method, causes the respective DeviceExecItem monitored on the front-end to be set in state DeviceExecItem.State.FINISHED_SUCCESS.

Parameters:

result - execution result value.

warning

void warning(java.lang.String warningMessage)

Sets the method execution is finished with warning(s). Using this method, causes the respective DeviceExecItem monitored on the front-end to be set in state DeviceExecItem.State.FINISHED_WARNING.

Parameters:

warningMessage - the warning message explaining what was possibly not OK during the method execution.

error

void error(java.lang.Throwable error)

Sets the method execution is finished with error(s). Using this method, causes the respective DeviceExecItem monitored on the front-end to be set in state DeviceExecItem.State.FINISHED_ERROR.

Parameters:

error - the execution error.

notReadyToExecute

void notReadyToExecute()

Notifies the system that this method cannot be currently executed. Could be used for instance when device is not currently online to receive the execution command. Using this method, causes the respective DeviceExecItem monitored on the front-end to be set in state DeviceExecItem.State.RUNNING_NOT_READY_TO_EXECUTE, thus informing the user to not for the execution since it is not really started.

getProperties

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

Returns custom properties assigned to this method execution represented by this AsyncResult object. These properties can be assigned:

on the backend, by the setProperties(Map, boolean) method, or on the front end - via DeviceExecItem.setProperty(String, Object) and DeviceExecItem.setProperties(Map, boolean) methods.

Returns:

execution item properties.

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties,
                   boolean append)

Sets custom properties assigned to this method execution represented by this AsyncResult object. These properties will also become viewable on the front-end, via the DeviceExecItem.getProperty(String) and DeviceExecItem.getProperties() methods.

Parameters:

properties - custom properties.

append - if true the supplied properties will be appended/added to any properties currently existing for this execution item, otherwise any existing properties will be fully replaced by the supplied ones.