org.sakaiproject.entitybroker.entityprovider.capabilities
Interface ReferenceParseable

All Superinterfaces:

EntityProvider

public interface ReferenceParseable
extends EntityProvider

Indicates an entity provider has the capability of parsing its own reference string. An entity that does not implement this interface is assumed to deal in references of type EntityReference (/prefix/id or /prefix)
This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (aaronz@vt.edu), Antranig Basman (antranig@caret.cam.ac.uk)

Method Summary

EntityReference

getParsedExemplar() Returns an example instance of the EntityReference class that this EntityProvider uses as its reference type.

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Method Detail

getParsedExemplar

EntityReference getParsedExemplar()

Returns an example instance of the EntityReference class that this EntityProvider uses as its reference type. If you do not also implement ParseSpecParseable a default parse specification will be inferred for you (the entity prefix will always come first).
NOTE: you will probably want to override at LEAST the main constructor and a few other methods, check the commenting in the EntityReference for tips

Returns:

an entity reference class which must extend EntityReference