IERXRestDelegate Interface Reference

Inherited by ERXDefaultRestDelegate.

List of all members.

Public Member Functions
void	delete (ERXRestRequest deleteRequest, ERXRestContext context) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException
IERXRestEntityDelegate	entityDelegate (EOEntity entity)
String	entityNameForAlias (String entityAlias)
ERXRestKey	insert (ERXRestRequest insertRequest, ERXRestContext context) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException
ERXRestKey	process (ERXRestRequest restRequest, ERXRestContext context) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException
void	update (ERXRestRequest updateRequest, ERXRestContext context) throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException
ERXRestKey	view (ERXRestRequest restRequest, ERXRestContext restContext)

---

Detailed Description

IERXRestDelegate provides the core hooks into REST processing.

Author:

mschrag

---

Member Function Documentation

void delete	(	ERXRestRequest	deleteRequest,
		ERXRestContext	context
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException

Deletes the given object (NSArray of EOEnterpriseObject).

Parameters:

	deleteRequest	the incoming delete
	context	the rest context

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if the user attempts to delete objects that he/she is not permitted to delete
	ERXRestNotFoundException	if one of the requested objects does not exist

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

IERXRestEntityDelegate entityDelegate

(

EOEntity

entity

)

Returns the per-entity rest delegate.

Parameters:

entity

the entity

Returns:

the per-entity rest delegate

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

String entityNameForAlias

(

String

entityAlias

)

Returns the actual name for the entity from its aliased name. The mappings for aliases is acquired when entity delegates are registered by calling entityAliasForEntityNamed.

Parameters:

entityAlias

the entity alias

Returns:

the actual entity name

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

ERXRestKey insert	(	ERXRestRequest	insertRequest,
		ERXRestContext	context
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException

Creates the objects defined by the XML document (which can contain a single object or an array inserts).

Parameters:

	insertRequest	the incoming inserts
	context	the rest context

Returns:

the inserted objects as an ERXRestResult

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if the user attempts to insert objects that he/she is not permitted to insert
	ERXRestNotFoundException	if one of the requested objects does not exist

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

ERXRestKey process	(	ERXRestRequest	restRequest,
		ERXRestContext	context
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException

Inserts or updates the objects defined by the XML document.

Parameters:

	restRequest	the incoming inserts or updates
	context	the rest context

Returns:

the inserted or updates objects as an ERXRestResult

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if the user attempts to insert or updates objects that he/she is not permitted to
	ERXRestNotFoundException	if one of the requested objects does not exist

Implemented in ERXDefaultRestDelegate.

void update	(	ERXRestRequest	updateRequest,
		ERXRestContext	context
	)			throws ERXRestException, ERXRestSecurityException, ERXRestNotFoundException

Updates the objects defined by the XML document (which can contain partial updates or array updates).

Parameters:

	updateRequest	the incoming updates
	context	the rest context

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if the user attempts to update objects that he/she is not permitted to update
	ERXRestNotFoundException	if one of the requested objects does not exist

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

ERXRestKey view	(	ERXRestRequest	restRequest,
		ERXRestContext	restContext
	)

Views the object defined by the incoming url.

Parameters:

	restRequest	the incoming viewing request.
	restContext	the rest context

Returns:

the actual result as an ERXRestResult

Exceptions:

	ERXRestException	if there is a general failure
	ERXRestSecurityException	if the user attempts to insert or updates objects that he/she is not permitted to
	ERXRestNotFoundException	if one of the requested objects does not exist

Implemented in ERXDefaultRestDelegate, and ERD2RestDelegate.

---

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

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