|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskOutputHandle
A task response that consists of a task identifier, an output from the service
(if any), and an exception (if any).
For synchronous retrieval of task responses, Session.fetchTaskOutput
can be invoked to retrieve an EnumItems
object, which contains a
series of TaskOutputHandle
s. You can enumerate through
this object by calling EnumItems.getNext
.
For asynchronous processing of task responses, the TaskOutputHandle
will be passed into the SessionCallback.onResponse
method when that
task has completed.
NOTE: If any of the methods of this interface are called after the main(...) method exits,
the client or service process may behave in an undefined manner (for example,
hang or terminate abnormally).
Session.fetchTaskOutput(long)
,
SessionCallback
,
EnumItems.getNext()
,
TaskInputHandle
Method Summary | |
---|---|
SoamException |
getException()
Retrieves the attached exception if the task was unsuccessful. |
java.lang.String |
getId()
Returns the task identifier for this task. |
java.lang.Object |
getTaskOutput()
Retrieves the task output object that was passed back to the client from the service. |
boolean |
isSuccessful()
Indicates whether the corresponding task was successfully processed by the service instance. |
void |
populateTaskOutput(Message message)
Populates message with the task result that was passed back to
the client from the service. |
Method Detail |
---|
java.lang.String getId() throws SoamException
TaskInputHandle
within the same Session
to match the input from a client to the
output retrieved from the service.
TaskOutputHandle
SoamException
Session.sendTaskInput(com.platform.symphony.soam.TaskSubmissionAttributes)
,
Session.fetchTaskOutput(long)
,
TaskInputHandle.getId()
boolean isSuccessful() throws SoamException
SoamException
void populateTaskOutput(Message message) throws SoamException
message
with the task result that was passed back to
the client from the service.
TaskOutputHandle.isSuccessful
to verify that the task had succeeded.
com.platform.symphony.soam.Message
using Symphony Serialization, you must use this method to retrieve it.
java.io.Serializable
using Native
Serialization, use the getTaskOutput
method instead.
message
- The message to populate.
SoamException
TaskContext.setTaskOutput(Message)
,
isSuccessful()
,
getTaskOutput()
java.lang.Object getTaskOutput() throws SoamException
TaskOutputHandle.isSuccessful
to verify that the task had succeeded.
java.io.Serializable
using Native Serialization, you must use this method to retrieve it.
com.platform.symphony.soam.Message
using
Symphony Serialization, use the populateTaskOutput
method instead.
SoamException
TaskContext.setTaskOutput(Serializable)
,
isSuccessful()
,
populateTaskOutput(com.platform.symphony.soam.Message)
SoamException getException() throws SoamException
TaskOutputHandle.isSuccessful
to verify that the task had failed.
SoamException
isSuccessful()
|
Version 5.1 Date Modified: -DREL_DATE=Apr 28 2011 Platform Computing. Accelerating Intelligence(TM). Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |