Package org.sakaiproject.entitybroker.entityprovider.capabilities

Interface DescribeDefineable

  • All Superinterfaces:
    Describeable, EntityProvider
    public interface DescribeDefineable
extends Describeable
    Allows an entity to define the description of itself in code rather than using properties, this will be called each time a description is needed so it should be efficient
    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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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

    • Method Detail

      • getDescription

        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
        Parameters:
        locale - this is the locale that the description should be created for
        descriptionKey - (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 in
        Returns:
        the string which describes this entity or this capability for this entity OR '' for no description OR return null to allow this to attempt to get the value from the properties file