|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskContext
Provides the context for the task that is bound to the given service invocation.
Method Summary | |
---|---|
void |
discardTaskInput()
Frees the middleware's local copy of the Task input. |
java.lang.String |
getSessionId()
Returns the identifier of the Session that owns this task. |
java.lang.String |
getTaskId()
Returns the identifier for this task. |
java.lang.Object |
getTaskInput()
Retrieves the task input object that was sent from the client to the service. |
void |
populateTaskInput(Message inMsg)
Populates inMsg with the task input that was passed from
the client to the service. |
void |
setTaskOutput(Message outMsg)
Sets the task output message that is to be sent back to the client. |
void |
setTaskOutput(java.io.Serializable outputObj)
Sets the task output object that is to be sent back to the client. |
Method Detail |
---|
java.lang.String getSessionId() throws SoamException
Session
that owns this task.
Session
identifier
SoamException
java.lang.String getTaskId() throws SoamException
SoamException
void populateTaskInput(Message inMsg) throws SoamException
inMsg
with the task input that was passed from
the client to the service.
com.platform.symphony.soam.Message
using Symphony Serialization, you must use this method to retrieve it.
java.io.Serializable
using Native
Serialization, use the getTaskInput
method instead.
inMsg
- The message to populate.
SoamException
Session.sendTaskInput(Message)
,
Session.sendTaskInput(Message, boolean)
java.lang.Object getTaskInput() throws SoamException
java.io.Serializable
using Native Serialization, you must use this method to retrieve it.
com.platform.symphony.soam.Message
using
Symphony Serialization, use the populateTaskInput
method instead.
SoamException
Session.sendTaskInput(Serializable)
,
Session.sendTaskInput(Serializable, boolean)
void setTaskOutput(Message outMsg) throws SoamException
Session.fetchTaskOutput
for a synchronous Session
,
or implement a SessionCallback
for an asynchronous
Session
.
setTaskOutput
overload uses Symphony Serialization.
That is, the service will send your task output to the client as a
com.platform.symphony.soam.Message
. If you set your
task output using this overload, you must retrieve your task output
on the client with the TaskOutputHandle.populateTaskOutput(Message)
method.
outMsg
- The output message to be returned to the client
SoamException
Session.fetchTaskOutput(long)
,
SessionCallback
,
TaskOutputHandle.populateTaskOutput(com.platform.symphony.soam.Message)
void setTaskOutput(java.io.Serializable outputObj) throws SoamException
Session.fetchTaskOutput
for a synchronous Session
,
or implement a SessionCallback
for an asynchronous
Session
.
setTaskOutput
overload uses Native Serialization.
That is, the service will send your task output to the client as a
java.io.Serializable
. If you set your task output
using this overload, you must retrieve your task output on the
client with the TaskOutputHandle.getTaskOutput()
method.
setTaskOutput
overload to send your task output
as a com.platform.symphony.soam.Message
using
Symphony Serialization.
outputObj
- The output object to be returned to the client.
SoamException
Session.fetchTaskOutput(long)
,
SessionCallback
,
TaskOutputHandle.getTaskOutput()
void discardTaskInput() throws SoamException
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 |