This entity will describe itself,
this description can be accessed for display in interfaces,
the description should generally be targeted at developers
(in particular, those using REST or web services)
This is the convention interface, it will simply look for the properties file
in the classloader which your
EntityProvider is located in,
the file must be named
<entity-prefix>.properties (e.g. myentity.properties)
The keys inside the file must be as follows:
<entity-prefix> = This is the main description of the entity, appears at the top
<entity-prefix>.view.<viewKey> = This is a description about a particular view for an entity (viewKey from entity view constants
EntityView.VIEW_LIST)
<entity-prefix>.action.<actionKey> = This is a description of a custom action for this entity (see
ActionsExecutable or
EntityCustomAction)
<entity-prefix>.field.<fieldName> = This is a description about a particular entity field for this entity object (see
Resolvable or
CollectionResolvable)
<entity-prefix>.redirect.<redirectTemplate> = This is a description about a particular redirect rule for this entity URL space (see
Redirectable or
EntityURLRedirect)
<entity-prefix>.<capability> = This is a description about a particular capability for this entity
Example:<![CDATA[
myentity = This is my entity, it is used for <b>examples</b> only
myentity.view.show = this shows a single instance of my entity
myentity.action.copy = this makes a copy of an instance of a myentity
myentity.field.name = this is the name of the entity, it is a user displayable name
myentity.redirect./{prefix}/xml/{id} = redirects to an xml view of a myentity
myentity.Inputable = <i>extra</i> notes about the Inputable implementation for myentity
]]>
If you need to define the location of your properties file then use:
DescribePropertiesable
This is one of the capability extensions for the
EntityProvider interface