er.rest

Interface IERXRestDelegate

All Known Implementing Classes:

EOEntityRestDelegate, EOModelGroupRestDelegate, EOModelRestDelegate, ERXAbstractRestDelegate, ERXEORestDelegate, ERXNoOpRestDelegate

public interface IERXRestDelegate

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

Author:

mschrag

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IERXRestDelegate.Factory A Factory for creating IERXRestDelegates.

Method Summary

Modifier and Type	Method and Description
boolean	__hasNumericPrimaryKeys(EOClassDescription classDescription) This API will likely change.
Object	createObjectOfEntityWithID(EOClassDescription entity, Object id, ERXRestContext context) Creates a new instance of the entity.
Object	objectOfEntityWithID(EOClassDescription entity, Object id, ERXRestContext context) Returns the object with the given entity and ID.
Object	primaryKeyForObject(Object obj, ERXRestContext context) Returns the primary key for the specified object.

Method Detail

primaryKeyForObject

Object primaryKeyForObject(Object obj,
                           ERXRestContext context)

Returns the primary key for the specified object.

Parameters:

obj - the object to return a pk for

context - the REST context

Returns:

the primary key of the object

createObjectOfEntityWithID

Object createObjectOfEntityWithID(EOClassDescription entity,
                                  Object id,
                                  ERXRestContext context)

Creates a new instance of the entity.

Parameters:

entity - the entity

id - the ID of the object

context - the REST context

Returns:

a new instance of the entity

objectOfEntityWithID

Object objectOfEntityWithID(EOClassDescription entity,
                            Object id,
                            ERXRestContext context)

Returns the object with the given entity and ID.

Parameters:

entity - the entity

id - the ID of the object

context - the REST context

Returns:

the object with the given entity and ID

__hasNumericPrimaryKeys

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