com.continuent.tungsten.common.tdf
Class TdfApiResponse

java.lang.Object
  com.continuent.tungsten.common.tdf.TdfApiResponse

public class TdfApiResponse
extends java.lang.Object

This class defines a APIResponse. Used by the manager API and TDF API as response class to all of the calls.

Version:

1.0

Author:

Ludovic Launer

Nested Class Summary

static class

TdfApiResponse.Builder Builder class for a TdfApiResponse

Field Summary

protected java.lang.Object	inputObject The initial request URI as sent to the API
protected java.lang.Object	outputPayload The type of the outputPayload Object
protected java.net.URI	requestURI
protected java.net.URI	responseURI The input object passed as a parameter to the API
protected java.lang.Integer	returnCode Return message related to the returnCode and adding more information
protected java.lang.String	returnMessage The response Object providing the API return value

Constructor Summary

TdfApiResponse()
Creates a new TdfApiResponse object

TdfApiResponse(java.net.URI requestURI)
Creates a new TdfApiResponse object

Method Summary

java.lang.Object	getInputObject()
java.lang.Object	getOutputPayload()
java.lang.Class<?>	getOutputPayloadClass() Returns the outputPayloadClass value.
java.net.URI	getRequestURI()
java.net.URI	getResponseURI()
java.lang.Integer	getReturnCode()
java.lang.String	getReturnMessage() Get the returnMessage.
void	setInputObject(java.lang.Object inputObject)
void	setOutputPayload(java.lang.Object outputPayload)
void	setRequestURI(java.net.URI requestURI)
void	setResponseURI(java.net.URI responseURI)
void	setReturnCode(java.lang.Integer returnCode)
void	setReturnMessage(java.lang.String returnMessage)

Methods inherited from class java.lang.Object

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

Field Detail

requestURI

protected java.net.URI requestURI

inputObject

protected java.lang.Object inputObject

The initial request URI as sent to the API

responseURI

protected java.net.URI responseURI

The input object passed as a parameter to the API

returnCode

protected java.lang.Integer returnCode

Return message related to the returnCode and adding more information

returnMessage

protected java.lang.String returnMessage

The response Object providing the API return value

outputPayload

protected java.lang.Object outputPayload

The type of the outputPayload Object

Constructor Detail

TdfApiResponse

public TdfApiResponse()

Creates a new TdfApiResponse object

TdfApiResponse

public TdfApiResponse(java.net.URI requestURI)

Creates a new TdfApiResponse object

Parameters:

requestURI - The URI corresponding to the submitted request.

Method Detail

getOutputPayloadClass

public java.lang.Class<?> getOutputPayloadClass()

Returns the outputPayloadClass value.

Returns:

Returns the outputPayloadClass.

getReturnMessage

public java.lang.String getReturnMessage()

Get the returnMessage. If null, tries to get the return Message from the returnCode.

Returns:

the returnMessage as set by the user, or as derived from the returnCode

getRequestURI

public java.net.URI getRequestURI()

setRequestURI

public void setRequestURI(java.net.URI requestURI)

getInputObject

public java.lang.Object getInputObject()

setInputObject

public void setInputObject(java.lang.Object inputObject)

getResponseURI

public java.net.URI getResponseURI()

setResponseURI

public void setResponseURI(java.net.URI responseURI)

getReturnCode

public java.lang.Integer getReturnCode()

setReturnCode

public void setReturnCode(java.lang.Integer returnCode)

setReturnMessage

public void setReturnMessage(java.lang.String returnMessage)

getOutputPayload

public java.lang.Object getOutputPayload()

setOutputPayload

public void setOutputPayload(java.lang.Object outputPayload)