Visit Platform at http://www.platform.com

Main Page   Compound List   Compound Members  

ISoamTaskOutputHandle Interface Reference

Hosts a task ID, a message response (if any), and an exception (if any) from SOAM. More...

List of all members.


Public Methods

HRESULT PopulateTaskOutput ([in, out] ISoamMessage **message)
 Retrieves the output associated with the task.

HRESULT Id ([out, retval] BSTR *pVal)
 Gets the task ID of a TaskOutputHandle returned by SOAM.

HRESULT IsSuccessful ([out, retval] VARIANT_BOOL *pVal)
 Check if a message has been successfully processed by SOAM.

HRESULT GetException ([out, retval] ISoamCOMException **pVal)
 Returns the exception if the task was unsuccessful.


Detailed Description

Hosts a task ID, a message response (if any), and an exception (if any) from SOAM.

For synchronous message retrieval, an enumeration of TaskOutputHandles will be returned from the Session::fetchTaskOutput() method. You can enumerate through this object by calling EnumItems::getNext. For asynchronous message retrieval, a TaskOutputHandle is passed as an argument to the SessionCallback::onResponse handler for every task that has completed.

See also:
ISoamSession::fetchTaskOutput , ISoamEnum::getNext , ISoamTaskInputHandle , SessionCallback::onResponse


Member Function Documentation

HRESULT PopulateTaskOutput [in, out] ISoamMessage **    message
 

Retrieves the output associated with the task.

Deserializes the returned message (if any) into the message output object provided by the client. If the task failed and this method is called, an exception will be thrown.

Parameters:
outputMessage  [OUT] a response message from the SOAM service.
Exceptions:
ISoamException 
See also:
ISoamMessage::onDeserialize

HRESULT Id [out, retval] BSTR *    pVal
 

Gets the task ID of a TaskOutputHandle returned by SOAM.

This task ID can be compared with the task ID retrieved from a TaskInputHandle in the same session when sending messages to SOAM, to match the input from client and output from the service.

Returns:
a TaskOutputHandle ID.
Exceptions:
ISoamException 
See also:
ISoamSession::sendTaskInput , ISoamSession::fetchTaskOutput , TaskInputHandle::getId

HRESULT IsSuccessful [out, retval] VARIANT_BOOL *    pVal
 

Check if a message has been successfully processed by SOAM.

Gives an indication if a task was successfully processed by the service instance.

Returns:
TRUE to indicate the request has been successfully processed by SOAM, or FALSE if the request was not successfully processed.
Exceptions:
ISoamException 

HRESULT GetException [out, retval] ISoamCOMException **    pVal
 

Returns the exception if the task was unsuccessful.

This method will retrieve the attached exception and will only be valid if the task was unsuccessful. If the task was successful and this method is called an exception will be thrown.

Returns:
an exception object generated by SOAM or service.
Exceptions:
ISoamException 


     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2008 Platform Computing Corporation. All rights reserved.