InterpretationResult (Bosch IoT Remote Manager 7.1 Generic Device Management Package API)

```
public interface InterpretationResult
```
Represents a result of custom interpretation of commands on the backend. An InterpretationResult object could be in one of the four following modes: SUCCESS, WARINING, ERROR, TO_PROCEED that shall determine the manipulation of this InterpretationResult on the backend. Instances of this interface are created by the mPRM system and disposed to custom backend command interpreters registered in the MS framework service registry.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR` ERROR mode denotes that the command is completely executed but finished with error on the backend and nothing else should be executed on the target device.
`static int`	`OFFLINE_INTERPRETATION` OFFLINE_INTERPRETATION mode indicates that command will be executed asynchronously and may be confirmed in subsequent connection establishment sessions.
`static int`	`SUCCESS` SUCCESS mode denotes that the command is completely and successfully executed on the backend and there is no need anything else to be executed on the target device.
`static int`	`TO_PROCEED` TO_PROCEED mode denotes that the command is partially executed on the backend and in addition another (or the same) command(s) should be sent to the target device for execution.
`static int`	`WARNING` WARNING mode denotes that the command is completely executed but finished with warning on the backend and nothing else should be executed on the target device.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCommandId()` Returns a system generated command identifier of the command, which interpretation result should be applied with this object.
`java.util.Dictionary<java.lang.String,java.lang.Object>`	`getCommandProperties()`
`java.lang.Object`	`getInterpretationContext()` Returns the interpretation context object currently set for the current chunk of commands under the same interpretation group.
`java.lang.String`	`getOperationId()` Returns id of the operation, the command is executed within.
`OperationInfo`	`getOperationInfo()` Returns additional info for the operation being executed.
`void`	`resetOfflineInterpretationMode()` Reverts the command from being marked in offline interpretation mode.
`void`	`setCommandProperty(java.lang.String key, java.lang.Object value)`
`void`	`setError(java.lang.String errorMessage)` Sets this `InterpretationResult` object in `ERROR` mode and invalidates this `InterpretationResult` object.
`void`	`setExecutionStarted()` This method notifies the system that execution of that command shall be (or is) started, but the result could be delayed indefinitely (for example when sending the command for interpretation to the client device).
`void`	`setInterpretationContext(java.lang.Object interpretationContext)` Sets interpretation context object for buffering the command jobs for the current chunk of commands under the same interpretation group.
`void`	`setOfflineInterpretationMode()` Marks the command as being interpreted offline and may be confirmed in subsequent connection establishment sessions.
`void`	`setSuccess(java.lang.Object commandResult)` Sets this `InterpretationResult` object to in success mode and invalidates this `InterpretationResult` object.
`void`	`setToProceed(Command command)` Sets this `InterpretationResult` object in `TO_PROCEED` mode and invalidates this `InterpretationResult` object.
`void`	`setToProceedSync(Command command)` Sets this `InterpretationResult` object in `TO_PROCEED` mode, causing the supplied commands to be interpreted in the same thread `setToProceedSync` is invoked.
`void`	`setWarning(java.lang.String errorMessage)` Sets this `InterpretationResult` object in `WARNING` mode and invalidates this `InterpretationResult` object.

- Field Detail
  - SUCCESS
```
static final int SUCCESS
```
    SUCCESS mode denotes that the command is completely and successfully executed on the backend and there is no need anything else to be executed on the target device.
    
    See Also:
    
    Constant Field Values
  - WARNING
```
static final int WARNING
```
    WARNING mode denotes that the command is completely executed but finished with warning on the backend and nothing else should be executed on the target device.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
static final int ERROR
```
    ERROR mode denotes that the command is completely executed but finished with error on the backend and nothing else should be executed on the target device.
    
    See Also:
    
    Constant Field Values
  - TO_PROCEED
```
static final int TO_PROCEED
```
    TO_PROCEED mode denotes that the command is partially executed on the backend and in addition another (or the same) command(s) should be sent to the target device for execution.
    
    See Also:
    
    Constant Field Values
  - OFFLINE_INTERPRETATION
```
static final int OFFLINE_INTERPRETATION
```
    OFFLINE_INTERPRETATION mode indicates that command will be executed asynchronously and may be confirmed in subsequent connection establishment sessions. Commands entered in OFFLINE_INTERPRETATION mode will not be re-forced when calling OperationManagementContext.forcePendingCommands(String, String) to the system, since the command is considered to be in process of interpretation (even though connection session may be lost), and needs not to be forced again causing duplicate executions. In fact, this mode marks the command to not be resent when calling OperationManagementContext.forcePendingCommands(String, String) to the system.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCommandId
```
java.lang.String getCommandId()
```
    Returns a system generated command identifier of the command, which interpretation result should be applied with this object.
    
    Returns:
    
    command id.
  - getOperationId
```
java.lang.String getOperationId()
```
    Returns id of the operation, the command is executed within.
    
    Returns:
    
    operation id.
  - setSuccess
```
void setSuccess(java.lang.Object commandResult)
```
    Sets this InterpretationResult object to in success mode and invalidates this InterpretationResult object.
    
    Parameters:
    
    commandResult - if the command execution is meant to return a result, the interpreters can set it with this parameter. Any CommandResultListener-s registered to listen for command results of this kind will receive the object given in this parameter.
    
    Throws:
    
    java.lang.Exception - thrown if this InterpretationResult object has been invalidated.
    
    See Also:
    
    CommandResultsListener.addingResult(String, String, String, String, int, Object), CommandResultListener.addingResult(String, String, String, String, int, Object)
  - setToProceed
```
void setToProceed(Command command)
```
    Sets this InterpretationResult object in TO_PROCEED mode and invalidates this InterpretationResult object.
    
    Parameters:
    
    command - a result command to proceed execution over the target device.
  - setToProceedSync
```
void setToProceedSync(Command command)
```
    Sets this InterpretationResult object in TO_PROCEED mode, causing the supplied commands to be interpreted in the same thread setToProceedSync is invoked.
    
    Parameters:
    
    command - a result command to proceed execution over the target device.
  - setOfflineInterpretationMode
```
void setOfflineInterpretationMode()
```
    Marks the command as being interpreted offline and may be confirmed in subsequent connection establishment sessions. Commands marked with offline interpretation will not be re-forced when calling OperationManagementContext.forcePendingCommands(String, String) to the system, since the command is considered to be in process of interpretation (even though connection session may be lost), and needs not to be forced again causing duplicate executions. In fact, this method marks the command to not be resent when calling OperationManagementContext.forcePendingCommands(String, String) to the system.
  - resetOfflineInterpretationMode
```
void resetOfflineInterpretationMode()
```
    Reverts the command from being marked in offline interpretation mode. That is undoing the call of setOfflineInterpretationMode(), and the command will start being sent when calling OperationManagementContext.forcePendingCommands(String, String) to the system.
  - setWarning
```
void setWarning(java.lang.String errorMessage)
```
    Sets this InterpretationResult object in WARNING mode and invalidates this InterpretationResult object.
    
    Parameters:
    
    errorMessage - an error message denoting the failure reason.
  - setError
```
void setError(java.lang.String errorMessage)
```
    Sets this InterpretationResult object in ERROR mode and invalidates this InterpretationResult object.
    
    Parameters:
    
    errorMessage - an error message denoting the failure reason.
  - setExecutionStarted
```
void setExecutionStarted()
```
    This method notifies the system that execution of that command shall be (or is) started, but the result could be delayed indefinitely (for example when sending the command for interpretation to the client device). The system supports a limitation of the concurrent asynchronous command executions to prevent a wave of command responses to overload the server when too many devices start replying the command job. By calling setExecutionStarted for the current command, the system fills it in the concurrent active jobs pool. When confirmation of command is done (via the setSuccess, setWarning, setError or setToProceed) methods, the current command will also leave the pool and will make a room for another command to be launched.
  - setInterpretationContext
```
void setInterpretationContext(java.lang.Object interpretationContext)
```
    Sets interpretation context object for buffering the command jobs for the current chunk of commands under the same interpretation group. Interpretation context objects are distinguished in the scope of (operation id, device type, device id, interpretation group id). (See: InterpretationGroup
    
    Parameters:
    
    interpretationContext - interpretation context object.
  - getInterpretationContext
```
java.lang.Object getInterpretationContext()
```
    Returns the interpretation context object currently set for the current chunk of commands under the same interpretation group. Interpretation context objects are distinguished in the scope of (operation id, device type, device id, interpretation group id). (See: InterpretationGroup
    
    Returns:
    
    interpretation context object.
  - getOperationInfo
```
OperationInfo getOperationInfo()
```
    Returns additional info for the operation being executed.
    
    Returns:
    
    OperationInfo object.
  - getCommandProperties
```
java.util.Dictionary<java.lang.String,java.lang.Object> getCommandProperties()
```
  - setCommandProperty
```
void setCommandProperty(java.lang.String key,
                        java.lang.Object value)
```

Interface InterpretationResult

Field Summary

Method Summary

Field Detail

SUCCESS

WARNING

ERROR

TO_PROCEED

OFFLINE_INTERPRETATION

Method Detail

getCommandId

getOperationId

setSuccess

setToProceed

setToProceedSync

setOfflineInterpretationMode

resetOfflineInterpretationMode

setWarning

setError

setExecutionStarted

setInterpretationContext

getInterpretationContext

getOperationInfo

getCommandProperties

setCommandProperty