|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskInputHandle
Will be returned to the client once a task input has been sent to the middleware, and used by the client to match a task input to the corresponding task response.
Session.sendTaskInput(Serializable)
,
Session.sendTaskInput(Message)
,
TaskOutputHandle
Field Summary | |
---|---|
static int |
SUBMIT_COMPLETED
The message has been successfully dispatched to the Middleware. |
static int |
SUBMIT_FAILED
The dispatch of the message was un-successful. |
static int |
SUBMIT_PENDING
The message has been dispatched and a confirmation of receipt is pending from the Middleware. |
static int |
SUBMIT_STATE_UNKNOWN
No information is available about the state at this time. |
Method Summary | |
---|---|
SoamException |
getException()
Retrieves the attached exception if the message submission was unsuccessful. |
java.lang.String |
getId()
Retrieves the identifier associated with the task, which was created by the middleware when a task input was sent. |
int |
getSubmissionState()
Get the current state of submission. |
int |
waitForSubmissionComplete()
Waits for message submission to complete. |
int |
waitForSubmissionComplete(int timeoutInSeconds)
Waits for message submission to complete. |
int |
waitForSubmissionComplete(int timeoutInSeconds,
boolean throwOnSubmissionFailure)
Waits for message submission to complete. |
Field Detail |
---|
static final int SUBMIT_STATE_UNKNOWN
static final int SUBMIT_PENDING
static final int SUBMIT_COMPLETED
static final int SUBMIT_FAILED
Method Detail |
---|
java.lang.String getId() throws SoamException
Session
, this task ID can be saved and
compared with the task ID from a TaskOutputHandle
to match a task input to the corresponding task response.
SoamException
Session.sendTaskInput(Serializable)
,
Session.sendTaskInput(Message)
,
TaskOutputHandle.getId()
int getSubmissionState() throws SoamException
SoamException
SoamException getException() throws SoamException
TaskInputHandle.getSubmissionState
.
SoamException
getSubmissionState()
int waitForSubmissionComplete() throws SoamException
SoamException
int waitForSubmissionComplete(int timeoutInSeconds) throws SoamException
timeoutInSeconds
- The timeout in seconds. The valid range of the values for
timeout is 0 - 31,556,926 seconds.
SoamException
int waitForSubmissionComplete(int timeoutInSeconds, boolean throwOnSubmissionFailure) throws SoamException
timeoutInSeconds
- The timeout in seconds. The valid range of the values for
timeout is 0 - 31,556,926 seconds.throwOnSubmissionFailure
- When set to true the method will throw an exception
if the submission ends in failure. When set to false the method will simply return
the final state.
SoamException
|
Version 4.1 Date Modified: -DREL_DATE=Nov 03 2008 Platform Computing. Accelerating Intelligence(TM). Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |