org.sakaiproject.entitybroker.entityprovider.capabilities

Interface DescribePropertiesable

All Superinterfaces:

Describeable, EntityProvider

public interface DescribePropertiesable
extends Describeable

This allows an entity to define the Properties files/classes to be used for looking up descriptions of the entity (Describeable)
This is the configuration interface
This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

See Also:

Describeable

Method Summary

Modifier and Type	Method and Description
String	getBaseName() Defines the Properties file/class baseName which is used to find descriptions of an entity as per the keys defined in Describeable The baseName will be the file without the .properties or the locale codes Examples: myentity - would match: myentity.properties, myentity_en.properties, myentity_en_GB.properties, etc.
ClassLoader	getResourceClassLoader() Defines the ClassLoader which will be used to load the properties bundle file/classes which contain the entity descriptions

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

getEntityPrefix

Method Detail

getBaseName

String getBaseName()

Defines the Properties file/class baseName which is used to find descriptions of an entity as per the keys defined in Describeable
The baseName will be the file without the .properties or the locale codes
Examples:
myentity - would match: myentity.properties, myentity_en.properties, myentity_en_GB.properties, etc.
mydir/myloc/mything - would match: mydir/myloc/mything.properties, etc.

Returns:

the baseName of the properties file/classes in the getResourceClassLoader()

See Also:

for details about the keys to place in the properties file

getResourceClassLoader

ClassLoader getResourceClassLoader()

Defines the ClassLoader which will be used to load the properties bundle file/classes which contain the entity descriptions

Returns:

the ClassLoader which can find the files using getBaseName()