IERXRestDelegate Interface Reference

Inherited by ERXAbstractRestDelegate.

List of all members.

Classes

class  Factory

Public Member Functions

boolean __hasNumericPrimaryKeys (EOClassDescription classDescription)
Object createObjectOfEntityWithID (EOClassDescription entity, Object id)
Object objectOfEntityWithID (EOClassDescription entity, Object id)
Object primaryKeyForObject (Object obj)
void setEditingContext (EOEditingContext editingContext)


Detailed Description

The delegate interface used to convert objects to and from request nodes.

Author:
mschrag

Member Function Documentation

boolean __hasNumericPrimaryKeys ( EOClassDescription  classDescription  ) 

This API will likely change. Override if you have to for now, but I'm not sure if it makes more sense to return an array of pk classes, a map of pk to pk class, this boolean, or an array of pk attribute names. If we return pk names, we could probably get rid of primaryKeyForObject, or at least fully implement it in ERXAbstractRestDelegate, but I don't want to fully commit to this API yet. In the meantime, this at least provides a stapgap for automatic registration.

Parameters:
classDescription the class description in question
Returns:
whether or not the given class description has numeric pks

Implemented in ERXAbstractRestDelegate, and ERXEORestDelegate.

Object createObjectOfEntityWithID ( EOClassDescription  entity,
Object  id 
)

Creates a new instance of the entity.

Parameters:
entity the entity
Returns:
a new instance of the entity

Implemented in ERXAbstractRestDelegate.

Object objectOfEntityWithID ( EOClassDescription  entity,
Object  id 
)

Returns the object with the given entity and ID.

Parameters:
entity the entity
id the ID of the object
Returns:
the object with the given entity and ID

Implemented in ERXAbstractRestDelegate.

Object primaryKeyForObject ( Object  obj  ) 

Returns the primary key for the specified object.

Parameters:
obj the object to return a pk for
Returns:
the primary key of the object

Implemented in ERXAbstractRestDelegate.

void setEditingContext ( EOEditingContext  editingContext  ) 

Sets the editing context fort his rest delegate (which might not be necessary, but EO delegates require it).

Parameters:
editingContext the editing context for this delegate

Implemented in ERXAbstractRestDelegate.


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

Generated on Sat May 26 06:43:27 2012 for Project Wonder by  doxygen 1.5.8