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 typeEntityReference(/prefix/id or /prefix)
This is one of the capability extensions for theEntityProviderinterface- Author:
- Aaron Zeckoski (aaronz@vt.edu), Antranig Basman (antranig@caret.cam.ac.uk)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EntityReferencegetParsedExemplar()Returns an example instance of theEntityReferenceclass that thisEntityProvideruses as its reference type.-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider
getEntityPrefix
-
-
-
-
Method Detail
-
getParsedExemplar
EntityReference getParsedExemplar()
Returns an example instance of theEntityReferenceclass that thisEntityProvideruses as its reference type. If you do not also implementParseSpecParseablea 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 theEntityReferencefor tips- Returns:
- an entity reference class which must extend
EntityReference
-
-