org.sakaiproject.service.legacy.entity
Interface EntityManager

All Known Implementing Classes:

EntityManagerComponent

public interface EntityManager

EntityManager is the API for managing EntityProducer services / managers.

Author:

Sakai Software Development Team

Method Summary

List	getEntityProducers() Access the list of managers that are registered EntityProducer.
Reference	newReference(Reference copyMe) Create a new Reference object, as a copy of the given Reference object.
Reference	newReference(String refString) Create a new Reference object, from the given reference string.
List	newReferenceList() Create a new List specially designed to hold References.
List	newReferenceList(List copyMe) Create a new List specially designed to hold References, as a copy of another.
void	registerEntityProducer(EntityProducer manager, String referenceRoot) Register this as an EntityProducer.

Method Detail

getEntityProducers

public List getEntityProducers()

Access the list of managers that are registered EntityProducer.

Returns:

List (EntityProducer) of managers that are registered EntityProducer.

registerEntityProducer

public void registerEntityProducer(EntityProducer manager,
                                   String referenceRoot)

Register this as an EntityProducer.

Parameters:

manager - The EntityProducer manager to register.

referenceRoot - The prefix of all entity references handeled by this producer (i.e. "content" if you handle "/content/..." references)

newReference

public Reference newReference(String refString)

Create a new Reference object, from the given reference string.

Parameters:

refString - The reference string.

Returns:

a new reference object made from the given reference string.

newReference

public Reference newReference(Reference copyMe)

Create a new Reference object, as a copy of the given Reference object.

Parameters:

copyMe - The Reference object to copy

Returns:

a new Reference object, as a copy of the given Reference object.

newReferenceList

public List newReferenceList()

Create a new List specially designed to hold References.

Returns:

a new List specially designed to hold References.

newReferenceList

public List newReferenceList(List copyMe)

Create a new List specially designed to hold References, as a copy of another.

Parameters:

copyMe - Make the new list contain a copy of this list.

Returns:

a new List specially designed to hold References, as a copy of another.