public interface DescribeDefineable extends Describeable
EntityProvider interfaceDescribeable| Modifier and Type | Method and Description |
|---|---|
String |
getDescription(Locale locale,
String descriptionKey)
Allows for complete control over the descriptions of entities
This will always be called first if it is defined, returning a null will default to attempting to get the value from the properties (if any are defined), returning an empty string will cause nothing to be shown for the description |
getEntityPrefixString getDescription(Locale locale, String descriptionKey)
locale - this is the locale that the description should be created fordescriptionKey - (optional) if null then the general description of the entity should be created,
otherwise provide the description for the capability that was provided (e.g. Resolveable) OR
the custom action, starts with action.<actionKey> (e.g. action.promote),
see the Describeable interface for information about the other keys that will be passed inCopyright © 2003–2022 Sakai Project. All rights reserved.