er.rest.entityDelegates
Interface IERXRestResponseWriter

All Known Implementing Classes:

ERXAbstractRestResponseWriter, ERXDictionaryRestResponseWriter, ERXJSONRestResponseWriter, ERXPListRestResponseWriter, ERXXmlRestResponseWriter

public interface IERXRestResponseWriter

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

Author:

mschrag

Field Summary

static java.lang.String	DETAILS_PREFIX
static java.lang.String	DETAILS_PROPERTIES_PREFIX
static java.lang.String	REST_PREFIX

Method Summary

void	appendToResponse(ERXRestContext context, IERXRestResponse response, ERXRestKey result) Called at the end of a request to produce the output to the user.
java.lang.String	toString(com.webobjects.eocontrol.EOEditingContext editingContext, java.lang.String entityName, com.webobjects.foundation.NSArray values) Returns a String form of the given objects using the unsafe delegate.
java.lang.String	toString(com.webobjects.eoaccess.EOEntity entity, com.webobjects.foundation.NSArray values) Returns a String form of the given objects using the unsafe delegate.
java.lang.String	toString(java.lang.Object value) Returns a String form of the given object using the unsafe delegate.

Field Detail

REST_PREFIX

static final java.lang.String REST_PREFIX

See Also:

Constant Field Values

DETAILS_PREFIX

static final java.lang.String DETAILS_PREFIX

See Also:

Constant Field Values

DETAILS_PROPERTIES_PREFIX

static final java.lang.String DETAILS_PROPERTIES_PREFIX

See Also:

Constant Field Values

Method Detail

appendToResponse

void appendToResponse(ERXRestContext context,
                      IERXRestResponse response,
                      ERXRestKey result)
                      throws ERXRestException,
                             ERXRestSecurityException,
                             ERXRestNotFoundException,
                             java.text.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

Throws:

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

toString

java.lang.String toString(java.lang.Object value)
                          throws ERXRestException,
                                 ERXRestSecurityException,
                                 ERXRestNotFoundException,
                                 java.text.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

Throws:

ERXRestException

ERXRestSecurityException

ERXRestNotFoundException

ParseException

toString

java.lang.String toString(com.webobjects.eoaccess.EOEntity entity,
                          com.webobjects.foundation.NSArray values)
                          throws ERXRestException,
                                 ERXRestSecurityException,
                                 ERXRestNotFoundException,
                                 java.text.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

Throws:

ERXRestException

ERXRestSecurityException

ERXRestNotFoundException

ParseException

toString

java.lang.String toString(com.webobjects.eocontrol.EOEditingContext editingContext,
                          java.lang.String entityName,
                          com.webobjects.foundation.NSArray values)
                          throws ERXRestException,
                                 ERXRestSecurityException,
                                 ERXRestNotFoundException,
                                 java.text.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

Throws:

ERXRestException

ERXRestSecurityException

ERXRestNotFoundException

ParseException