org.starhope.catullus
Annotation Type OpEd

@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
@Documented
@Inherited
public @interface OpEd

“Op Ed” does not stand for “Opinions of the Editor,” but instead, “Operator Editable…” It's just going to be typed so often that the malapropistic abbreviation seemed entirely appropriate. This annotation is to be used to indicate a property pair (get/set) that can be edited by an operator using a basic editable-property-discovery mechanism.

Author:

brpocock@star-hope.org

Optional Element Summary

String	advice Optional “advice” string to help the operator understand the meaning of this property
String	groupWith Property groups can be assigned headings, and all properties with the same groupWith heading will appear together under that heading.
boolean	isAdvanced if this is an “advanced” field, then it will be hidden by default, even if the user has sufficient privileges to update it, usually behind some simple “advanced” expander box or tab.
String	label The label to display in the user-interface for this element; by default, it will show the name of the property without the “get/set” prefix; this enables more user-friendly names.
String	needCap Minimum security capability needed.
long	refreshView Time to live on the display of an attribute.

advice

public abstract String advice

Optional “advice” string to help the operator understand the meaning of this property

This can also be applied to classes.

Default:

""

groupWith

public abstract String groupWith

Property groups can be assigned headings, and all properties with the same groupWith heading will appear together under that heading.

Does not apply to classes.

Default:

""

isAdvanced

public abstract boolean isAdvanced

if this is an “advanced” field, then it will be hidden by default, even if the user has sufficient privileges to update it, usually behind some simple “advanced” expander box or tab.

Does not apply to classes.

Default:

false

label

public abstract String label

The label to display in the user-interface for this element; by default, it will show the name of the property without the “get/set” prefix; this enables more user-friendly names.

Can be used for classes, but probably a bad idea

Default:

""

needCap

public abstract String needCap

Minimum security capability needed. Can be specified as a label or an integer (including in hex), must represent a valid capability level, any that are not understood will revert to CAP_UNIVERSAL. Missing this annotation defaults to CAP_SYSOP_COMMANDS.

On a class, changes the default for that class to the specified level.

Default:

""

refreshView

public abstract long refreshView

Time to live on the display of an attribute. If possible, the editing interface should refresh the value from the getter every (this many) milliseconds. Useful for annotating values that are likely to be changing more frequently. Only applies to properties.

Default:

300000L