com.atlassian.gadgets.dashboard.internal
Interface UserPref

All Known Implementing Classes:

UserPrefImpl

public interface UserPref

A living breathing user pref with a current value

Method Summary

com.atlassian.gadgets.spec.DataType	getDataType() Returns the DataType of this pref.
String	getDefaultValue() Returns the pref's default value.
String	getDisplayName() Returns the display name of this parameter; if not explicitly set by the gadget, returns the name.
Map<String,String>	getEnumValues() Returns the possible values for an enumerated pref, or null if the pref is not an enum.
String	getName() Returns the pref name.
String	getValue() Returns the pref's current value.
boolean	isRequired() Returns true if the pref is required.

Method Detail

getName

String getName()

Returns the pref name.

Returns:

the pref name

getDisplayName

String getDisplayName()

Returns the display name of this parameter; if not explicitly set by the gadget, returns the name.

Returns:

the name to show the user for this pref

isRequired

boolean isRequired()

Returns true if the pref is required.

Returns:

true if the pref is required

getDataType

com.atlassian.gadgets.spec.DataType getDataType()

Returns the DataType of this pref.

Returns:

this pref's datatype

getEnumValues

Map<String,String> getEnumValues()

Returns the possible values for an enumerated pref, or null if the pref is not an enum.

Returns:

possible values for the pref

getDefaultValue

String getDefaultValue()

Returns the pref's default value.

Returns:

the default value of the pref or an empty string if there is no default value

getValue

String getValue()

Returns the pref's current value.

Returns:

the current value of the pref