public interface

ObjectConfigurationProperty

implements Map<K, V>
com.atlassian.configurable.ObjectConfigurationProperty
Known Indirect Subclasses

Class Overview

This interface is a property of an Object Configuration and contains a name, description, default value and the type (ObjectConfigurationTypes) of this property. It can also contain a list of values if the type has values specified for it e.g. select list.

Summary

Public Methods
String getCascadeFrom()
String getDefault()
Retreives the default value of this Property e.g.
String getDescription()
Retrieves the description of this Property e.g.
String getName()
Retrieves the name of this Property e.g.
int getType()
Retrieves the type of the Property e.g.
void init(Map params)
Initialises the object so it can retrieve values dependant on the parameters in the Map
boolean isEnabled()
Whether the property is enabled in the current context.
boolean isI18nValues()
void setCascadeFrom(String cascadeFrom)
void setI18nValues(boolean i18nValues)
[Expand]
Inherited Methods
From interface java.util.Map

Public Methods

public String getCascadeFrom ()

public String getDefault ()

Retreives the default value of this Property e.g. Sydney

Returns
  • Default value of Property

public String getDescription ()

Retrieves the description of this Property e.g. Please enter you current location

Returns
  • Description of the Property

public String getName ()

Retrieves the name of this Property e.g. City

Returns
  • Name of this Property

public int getType ()

Retrieves the type of the Property e.g. Text

Returns

public void init (Map params)

Initialises the object so it can retrieve values dependant on the parameters in the Map

public boolean isEnabled ()

Whether the property is enabled in the current context. It is up to the implementation to divine the context.

Returns
  • true only if the property is enabled.

public boolean isI18nValues ()

public void setCascadeFrom (String cascadeFrom)

public void setI18nValues (boolean i18nValues)