|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RestResult
Interface for any data that is returned from a RestCommand
. This interface allows access to the status of the returned command, the contentType of the returned data, the Object bean that composes the returned data, and a method to get a String representation of the response, formatted in a specified FormatType
.
Nested Class Summary | |
---|---|
static class |
RestResult.FormatType An enumeration of the supported FormatTypes known by the REST framework. |
Method Summary | |
---|---|
String |
getCharacterEncoding() Get character encoding |
String |
getContentType(RestResult.FormatType formatType) Gets the content type of your response, which can be used to set the content type of the response from the RestServlet . |
String |
getMessage() Gets text detail for this RestResult |
String |
getResponse(RestResult.FormatType formatType) Return the response in the specified format. |
Object |
getResponseBean() Gets this RestResult as a JavaBean Object . |
int |
getStatus() Gets the overall status of the RestResult . |
boolean |
isError() Returns whether or not the result is an error type result, which the RestServlet handles differently, setting the HTTP response code to the error status code and setting the error message rather than writing into the response |
Method Detail |
---|
String getResponse(RestResult.FormatType formatType)
formatType
- the desired FormatType
to encode the result asRestResult
Object getResponseBean()
RestResult
as a JavaBean Object
.String getContentType(RestResult.FormatType formatType)
RestServlet
.formatType
- the desired FormatType
for the response.String
int getStatus()
RestResult
.RestResult
.String getMessage()
RestResult
RestResult
boolean isError()
RestServlet
handles differently, setting the HTTP response code to the error status code and setting the error message rather than writing into the responseRestResult
is an error result.String getCharacterEncoding()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.