Skip navigation links

oracle.stellent.wcm.server.request
Class SiteResponse

java.lang.Object
oracle.stellent.wcm.server.request.SiteResponse

public class SiteResponse

extends java.lang.Object

The response from a SiteRequest. Dictates to the client how to present the response, which server resource(s) to include, errors, and other display information.

Nested Class Summary

static class	SiteResponse.ResponseObject<T>
static class	SiteResponse.ResponseType type of response contained in the response body
static class	SiteResponse.SiteError

Constructor Summary

SiteResponse()

Method Summary

<T> void	addResponseObject(SiteResponse.ResponseObject<T> key, T object)
void	clearError() Clear the error state for this response
java.lang.String	getBody()
java.lang.String	getBodyPostfix()
java.lang.String	getBodyPrefix()
SiteResponse.SiteError	getError()
java.lang.String	getFlag(java.lang.String name) Retrieve a flag
java.util.Set<java.lang.String>	getFlagNames()
java.util.Map<java.lang.String,java.lang.Object>	getObjects()
<T> T	getResponseObject(SiteResponse.ResponseObject<T> key)
SiteResponse.ResponseType	getResponseType()
boolean	hasError()
void	setBody(java.lang.String body)
void	setBodyPostfix(java.lang.String bodyPostfix)
void	setBodyPrefix(java.lang.String bodyPrefix)
void	setError(SiteRequestException exception) Add an error message that might later be displayed to the user
void	setError(SiteResponse.SiteError siteError) Add an error message that might later be displayed to the user
void	setFlag(java.lang.String name, java.lang.String value) Set a flag
void	setResponseType(SiteResponse.ResponseType responseType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteResponse

public SiteResponse()

Method Detail

getBody

public java.lang.String getBody()

Returns:

the response body

setBody

public void setBody(java.lang.String body)

getObjects

public java.util.Map<java.lang.String,java.lang.Object> getObjects()

Returns:

a collection of names mapped to objects to be made available if the response is of type SiteResponse.ResponseType.VIEW

addResponseObject

public <T> void addResponseObject(SiteResponse.ResponseObject<T> key,
                                  T object)

getResponseObject

public <T> T getResponseObject(SiteResponse.ResponseObject<T> key)

setError

public void setError(SiteRequestException exception)

Add an error message that might later be displayed to the user

Parameters:

exception - an exception that occurred

setError

public void setError(SiteResponse.SiteError siteError)

Add an error message that might later be displayed to the user

Parameters:

siteError - exception that occurred

getError

public SiteResponse.SiteError getError()

Returns:

the associated exception

clearError

public void clearError()

Clear the error state for this response

getFlag

public java.lang.String getFlag(java.lang.String name)

Retrieve a flag

Parameters:

name - the flag name

Returns:

the flag value or null if not set

setFlag

public void setFlag(java.lang.String name,
                    java.lang.String value)

Set a flag

Parameters:

name - the flag name

value - the flag value

getFlagNames

public java.util.Set<java.lang.String> getFlagNames()

Returns:

the flag names

hasError

public boolean hasError()

Returns:

True if and error messages have been added

getResponseType

public SiteResponse.ResponseType getResponseType()

Returns:

the type of response body

setResponseType

public void setResponseType(SiteResponse.ResponseType responseType)

getBodyPrefix

public java.lang.String getBodyPrefix()

Returns:

content to be output before the response body

setBodyPrefix

public void setBodyPrefix(java.lang.String bodyPrefix)

getBodyPostfix

public java.lang.String getBodyPostfix()

Returns:

content to the output after the response body

setBodyPostfix

public void setBodyPostfix(java.lang.String bodyPostfix)

Skip navigation links