|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CritterPropDescription
The CritterPropDescription objects are immutable beans, created by
CritterType
s to inform the external world about what types
of arguments they take.
A list of CritterPropDescription
s can easily be displayed in the UI
in the following format:
name: purpose (type.getValue())
...
For instance:
Name: a regex to match against the resource name (string)
Age: only allow resources created before this time (date)
Subclasses of this should exist as types in CritterPropType
Method Summary | |
---|---|
java.lang.String |
getId()
Returns the ID for the CritterProp associated with this
description. |
java.lang.String |
getName()
Returns a localized name for this prop. |
java.lang.String |
getPurpose()
Return a localized purpose. |
CritterPropType |
getType()
Return the type (I am a DATE, I am a STRING, etc.) |
boolean |
isRequired()
If true, the associated CritterProp is required. |
Method Detail |
---|
java.lang.String getId()
CritterProp
associated with this
description.
The return value from this method should be equal to the value of
CritterProp.getId()
java.lang.String getName()
CritterPropType getType()
java.lang.String getPurpose()
boolean isRequired()
CritterProp
is required.
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |