oracle.adf.view.rich.remote

Class RemoteApplicationResponse

java.lang.Object

oracle.adf.view.rich.remote.RemoteApplicationResponse

All Implemented Interfaces:

Serializable

public abstract class RemoteApplicationResponse
extends Object
implements Serializable

The response returned from a remote application request. This response contains a status flag which tells, generally, what happened durring the response as well as what the response result will look like. It returns a response type which will either be EMPTY, OBJECT or STREAM and it will also contain the task resuts that were returned from the various TaskHandlers that were executed durring the request.

The final piece that will be returned is an up-to-date RemoteApplicationInstance which can be used to make subsequent requests to this server for this instance.

Note: because of special stream handling that we have in place, just because an instance of a particular RemoteApplicationResponse is sent from the producer, it is not guarenteed that the same instance will be recieved on the consumer. Instead there will be a functional equivalent that complys with the contract of this interface but may not contain any additional methods or functions.

Since:

12.1.4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteApplicationResponse.Status The status of the execution result.
static class	RemoteApplicationResponse.Type This returns the type of response.

Constructor Summary

Constructors

Constructor and Description
RemoteApplicationResponse()

Method Summary

Modifier and Type	Method and Description
abstract RemoteApplicationInstance	getRemoteApplicationInstance() Returns the current RemoteAdfApplicationInstance.
abstract Object	getResult() Returns the result based on type.
abstract RemoteApplicationResponse.Status	getResultStatus() Returns the current Result Status
abstract RemoteApplicationResponse.Type	getResultType() Returns the current Result Type
Object	getTaskResult(String returnId) Returns the result of a particular Task invocation.
abstract Map<String,Serializable>	getTaskResultMap() Returns a unmodifiable map of TaskResults.
protected Object	writeReplace() To handle streaming requests and optimize the protocol, this method is implemented to return response objects based on type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteApplicationResponse

public RemoteApplicationResponse()

Method Detail

getTaskResult

public Object getTaskResult(String returnId)

Returns the result of a particular Task invocation. Tasks are registered via the RemoteApplicationRequest.addTask(java.lang.Class, java.io.Serializable...).

Parameters:

returnId - the return Id assigned by the addTask method

Returns:

the object returned from the task handler

getTaskResultMap

public abstract Map<String,Serializable> getTaskResultMap()

Returns a unmodifiable map of TaskResults.

Returns:

Unmodifiable map of TaskResults

getRemoteApplicationInstance

public abstract RemoteApplicationInstance getRemoteApplicationInstance()

Returns the current RemoteAdfApplicationInstance. This instance contains all of the updated information on the request.

Returns:

The current RemoteAdfApplicationInstance.

getResultStatus

public abstract RemoteApplicationResponse.Status getResultStatus()

Returns the current Result Status

Returns:

The current result status.

getResultType

public abstract RemoteApplicationResponse.Type getResultType()

Returns the current Result Type

Returns:

The current result type.

getResult

public abstract Object getResult()

Returns the result based on type. The getResult can return any number of objects, but there are certain result types which return specific types of responses. They are:

Type.STREAM

- returns an inputStream to get data directly from the server.

Type.EXCEPTION

- returns an Exception object.

Type.OBJECT

- this is a catch all. Returns an arbitrary object from the server

Returns:

Object to the result.

writeReplace

protected Object writeReplace()

To handle streaming requests and optimize the protocol, this method is implemented to return response objects based on type. In general, implementations will not have to override this, however, because of the way this method works, the type of object returned to the consumer will NOT be of the same type sent by the producer. Instead it will contain some highly optimized "copies" of the response. To return the origional object (which is not suggested), you could override this method to provide your own object.

Note: this method is used by the built-in java serialization system. Please do no refactor.

Returns:

The response object.