Interface DescribePropertiesable
-
- All Superinterfaces:
Describeable,EntityProvider
public interface DescribePropertiesable extends Describeable
This allows an entity to define thePropertiesfiles/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 theEntityProviderinterface- Author:
- Aaron Zeckoski (azeckoski @ gmail.com)
- See Also:
Describeable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBaseName()Defines thePropertiesfile/class baseName which is used to find descriptions of an entity as per the keys defined inDescribeable
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.ClassLoadergetResourceClassLoader()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 thePropertiesfile/class baseName which is used to find descriptions of an entity as per the keys defined inDescribeable
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()
-
-