IERXRestResponseWriter Interface Reference

Inherited by ERXAbstractRestResponseWriter, ERXJSONRestResponseWriter, and ERXPListRestResponseWriter.

Collaboration diagram for IERXRestResponseWriter:

[legend]

List of all members.

Public Member Functions
void	appendToResponse (ERXRestContext context, IERXRestResponse response, ERXRestKey result) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException
String	toString (EOEditingContext editingContext, String entityName, NSArray values) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException
String	toString (EOEntity entity, NSArray values) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException
String	toString (Object value) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException
Static Public Attributes
static final String	DETAILS_PREFIX = ".details"
static final String	DETAILS_PROPERTIES_PREFIX = ".detailsProperties"
static final String	REST_PREFIX = "ERXRest."

---

Detailed Description

IERXRestResponseWriter provides the interface for generating the output of a restful request.

Author:

mschrag

---

Member Function Documentation

void appendToResponse	(	ERXRestContext	context,
		IERXRestResponse	response,
		ERXRestKey	result
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException

Called at the end of a request to produce the output to the user.

Parameters:

	context	the rest context
	response	the response to write into
	result	the result of the rest request

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if there is a security violation
	ERXRestNotFoundException	if there is a missing entity
	ParseException	if there is a parse error

Implemented in ERXAbstractRestResponseWriter, ERXJSONRestResponseWriter, ERXPListRestResponseWriter, and ERXXmlRestResponseWriter.

String toString	(	EOEditingContext	editingContext,
		String	entityName,
		NSArray	values
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException

Returns a String form of the given objects using the unsafe delegate.

Parameters:

	editingContext	the editingcontext to resolve the given entity name within
	entityName	the entity name of the values of the array
	values	the values to write

Returns:

a string form of the value using the given writer

Exceptions:

	ERXRestException
	ERXRestSecurityException
	ERXRestNotFoundException
	ParseException

Implemented in ERXAbstractRestResponseWriter, ERXJSONRestResponseWriter, and ERXPListRestResponseWriter.

String toString	(	EOEntity	entity,
		NSArray	values
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException

Returns a String form of the given objects using the unsafe delegate.

Parameters:

values

the values to write

Returns:

a string form of the value using the given writer

Exceptions:

	ERXRestException
	ERXRestSecurityException
	ERXRestNotFoundException
	ParseException

Implemented in ERXAbstractRestResponseWriter, ERXJSONRestResponseWriter, and ERXPListRestResponseWriter.

String toString

(

Object

value

)

throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException, ParseException

Returns a String form of the given object using the unsafe delegate.

Parameters:

value

the value to write

Returns:

a string form of the value using the given writer

Exceptions:

	ERXRestException
	ERXRestSecurityException
	ERXRestNotFoundException
	ParseException

Implemented in ERXAbstractRestResponseWriter, ERXJSONRestResponseWriter, and ERXPListRestResponseWriter.

---

Member Data Documentation

final String DETAILS_PREFIX = ".details" [static]

final String DETAILS_PROPERTIES_PREFIX = ".detailsProperties" [static]

final String REST_PREFIX = "ERXRest." [static]

---

The documentation for this interface was generated from the following file:

• /opt/source/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/entityDelegates/IERXRestResponseWriter.java