com.atlassian.configurable
Interface ObjectConfigurationProperty

All Superinterfaces:
Map
All Known Implementing Classes:
ObjectConfigurationPropertyImpl, ValuesGeneratorObjectConfigurationProperty, XMLValuesObjectConfigurationProperty

public interface ObjectConfigurationProperty
extends Map

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.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Method Summary
 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)
           
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

init

void init(Map params)
Initialises the object so it can retrieve values dependant on the parameters in the Map

Parameters:
params -

getName

String getName()
Retrieves the name of this Property e.g. City

Returns:
Name of this Property

getDescription

String getDescription()
Retrieves the description of this Property e.g. Please enter you current location

Returns:
Description of the Property

getDefault

String getDefault()
Retreives the default value of this Property e.g. Sydney

Returns:
Default value of Property

getType

int getType()
Retrieves the type of the Property e.g. Text

Returns:
Type of property from ObjectConfigurationTypes

isI18nValues

boolean isI18nValues()

setI18nValues

void setI18nValues(boolean i18nValues)

getCascadeFrom

String getCascadeFrom()

setCascadeFrom

void setCascadeFrom(String cascadeFrom)

isEnabled

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.
Since:
28 Aug 2007 for JIRA v3.11


Copyright © 2002-2009 Atlassian. All Rights Reserved.