ERXRouteResults Class Reference

Inherits com::webobjects::appserver::WOActionResults.

Collaboration diagram for ERXRouteResults:

[legend]

List of all members.

Public Member Functions
	ERXRouteResults (WOContext context, ERXRestFormat format, ERXRestRequestNode responseNode)
ERXRestFormat	format ()
WOResponse	generateResponse ()
ERXRestRequestNode	responseNode ()
void	setHeaderForKey (String header, String key)
Private Attributes
WOContext	_context
ERXRestFormat	_format
NSMutableDictionary< String, String >	_headers
ERXRestRequestNode	_responseNode

---

Detailed Description

ERXRouteResults encapsulates the data necessary to produce a RESTful response. This object exists to defer the generation of the response (so you can chain together rest responders).

Author:

mschrag

---

Constructor & Destructor Documentation

ERXRouteResults	(	WOContext	context,
		ERXRestFormat	format,
		ERXRestRequestNode	responseNode
	)

Constructs an ERXRouteResults.

Parameters:

	context	the current context
	format	the intended format of this response
	responseNode	the ERXRestRequestNode to render

---

Member Function Documentation

ERXRestFormat format

(

)

Returns the intended format of this response.

Returns:

the intended format of this response

WOResponse generateResponse

(

)

Generates a WOResponse out of this ERXRouteResults.

Returns:

a generated WOResponse

ERXRestRequestNode responseNode

(

)

Returns the ERXRestRequestNode to render.

Returns:

the ERXRestRequestNode to render

void setHeaderForKey	(	String	header,
		String	key
	)

Adds a header for the resulting WOResponse.

Parameters:

	header	the header to add
	key	the key to add

---

Member Data Documentation

WOContext _context [private]

ERXRestFormat _format [private]

NSMutableDictionary<String, String> _headers [private]

ERXRestRequestNode _responseNode [private]

---

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

• /opt/source/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/routes/ERXRouteResults.java