org.dspace.app.xmlui.wing

Interface ObjectManager

All Known Implementing Classes:

DSpaceObjectManager

public interface ObjectManager

The object manager is a class that must be implemented by each specific repository implementation that identifies referenced objects. Since the DRI document includes references to external resources implementers of this class must know how objects are referenced.

The specific implementation of ObjectManager that is used is determined by the Wing component that is creating the reference.

Author:

Scott Phillips

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAllManagedRepositories() Return a list of all repositories managed by this manager.
String	getObjectType(Object object) Return a descriptive, repository specific, type for the object.
String	getObjectURL(Object object) Return a URL referencing the object's metadata.
String	getRepositoryIdentifier(Object object) Return a unique identifier of the repository this object is contained in.
boolean	manageObject(Object object) Determine if the supplied object is manageable by this implementation of ObjectManager.

Method Detail

manageObject

boolean manageObject(Object object)
                     throws WingException

Determine if the supplied object is manageable by this implementation of ObjectManager. If the object is manageable then manage it, and return true.

Parameters:

object - The object to be managed.

Returns:

true if the object can be managed, otherwise false.

Throws:

WingException - passed through.

getObjectURL

String getObjectURL(Object object)
                    throws WingException

Return a URL referencing the object's metadata. If this is unavailable return null.

Parameters:

object - The object being managed.

Returns:

the URL.

Throws:

WingException - passed through.

getObjectType

String getObjectType(Object object)
                     throws WingException

Return a descriptive, repository specific, type for the object. If this is unavailable return null.

Parameters:

object - The object being managed.

Returns:

name of the object's type.

Throws:

WingException - passed through.

getRepositoryIdentifier

String getRepositoryIdentifier(Object object)
                               throws WingException

Return a unique identifier of the repository this object is contained in. If this is unavailable return null.

Parameters:

object - The object being managed.

Returns:

the repository identifier.

Throws:

WingException - passed through.

getAllManagedRepositories

Map<String,String> getAllManagedRepositories()
                                             throws WingException

Return a list of all repositories managed by this manager. The hash should be of the form repository identifier as the key, and the value for each key is a metadata URL.

Returns:

a collection of repositories.

Throws:

WingException - passed through.