|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.server.request.SiteResponse
public class SiteResponse
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 | ||
---|---|---|
|
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() |
|
|
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(RequestException 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 |
---|
public SiteResponse()
Method Detail |
---|
public java.lang.String getBody()
public void setBody(java.lang.String body)
public java.util.Map<java.lang.String,java.lang.Object> getObjects()
SiteResponse.ResponseType.VIEW
public <T> void addResponseObject(SiteResponse.ResponseObject<T> key, T object)
public <T> T getResponseObject(SiteResponse.ResponseObject<T> key)
public void setError(RequestException exception)
exception
- an exception that occurredpublic void setError(SiteResponse.SiteError siteError)
siteError
- exception that occurredpublic SiteResponse.SiteError getError()
public void clearError()
public java.lang.String getFlag(java.lang.String name)
name
- the flag namepublic void setFlag(java.lang.String name, java.lang.String value)
name
- the flag namevalue
- the flag valuepublic java.util.Set<java.lang.String> getFlagNames()
public boolean hasError()
public SiteResponse.ResponseType getResponseType()
public void setResponseType(SiteResponse.ResponseType responseType)
public java.lang.String getBodyPrefix()
public void setBodyPrefix(java.lang.String bodyPrefix)
public java.lang.String getBodyPostfix()
public void setBodyPostfix(java.lang.String bodyPostfix)
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |