|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.routing.protocol.routingserver.requests.RequestCancelExecution
public abstract class RequestCancelExecution
This request allows you to cancel a currently running
RequestExecuteStrategy
,
RequestFindTarget
, or
RequestGetStatistic
.
It can be used, for example, if the client application decides that it does not need the requested resource.
Required parameters:
Name | Description |
---|---|
ExecutionId | The referenceId of the request you are cancelling. |
Name | Description |
---|---|
EventExecutionAck |
Indicates that the request executed successfully; provides information about the results of its execution. |
EventExecutionError |
Indicates that the request was not executed successfully. |
EventExecutionInProgress |
Indicates that URS has accepted the request and started to execute it. |
EventError |
Indicates that the request was unknown to URS, or that some parameters were missing or invalid. |
RequestCancelExecution requestCancelExecution =
RequestCancelExecution.create(referenceIdFromRequestToBeCancelled);
requestCancelExecution.setExecutionId(referenceIdFromRequestToBeCancelled);
Message retc = protocol.request(requestCancelExecution);
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestCancelExecution |
create()
Creates instance of RequestCancelExecution with no parameters set. |
static RequestCancelExecution |
create(java.lang.Integer executionId)
Creates instance of RequestCancelExecution with all parameters set. |
abstract java.lang.Integer |
getExecutionId()
The ReferenceId of the request that this request will be executed against. |
abstract java.lang.Integer |
getReferenceId()
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder. |
abstract void |
setExecutionId(int executionId)
The ReferenceId of the request that this request will be executed against. |
abstract void |
setExecutionId(java.lang.Integer executionId)
The ReferenceId of the request that this request will be executed against. |
abstract void |
setReferenceId(int referenceId)
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder. |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestCancelExecution create()
public static RequestCancelExecution create(java.lang.Integer executionId)
executionId
- Request reference to execute control command on.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getExecutionId()
public abstract void setExecutionId(java.lang.Integer executionId)
public abstract void setExecutionId(int executionId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |