com.atlassian.configurable
Interface ObjectConfiguration

All Known Implementing Classes:

ObjectConfigurationImpl

public interface ObjectConfiguration

This interface represents a holder for all the configuration information. E.g. Its fields and description

Author:

Owen Fellows

Method Summary

boolean	allFieldsHidden() Determines if there are any non-hidden fields.
String	getDescription(Map params) The Description of this instance of an Object Configuration
String[]	getEnabledFieldKeys() The enabled property keys for this configuration.
String	getFieldDefault(String key) Retrieves the default value for property with specified key
String	getFieldDescription(String key) Retrieves the description of a property with the specified key
String[]	getFieldKeys() All the property keys for this configuration.
String	getFieldName(String key) Retrieves the name of a property with the specified key
int	getFieldType(String key) Retrieves the type of the property with the specified key
Map	getFieldValues(String key) Retrieves a map of available values for property with the specified key.
Map	getFieldValuesHtmlEncoded(String key) Retrieves a map of available values for property with the specified key.
void	init(Map params) Initialises the object with some parameters
boolean	isEnabled(String key) Is a particular property enabled at the moment - may be a runtime check.
boolean	isI18NValues(String key)

Method Detail

init

void init(Map params)

Initialises the object with some parameters

Parameters:

params - Map of initialisation params

getFieldName

String getFieldName(String key)
                    throws ObjectConfigurationException

Retrieves the name of a property with the specified key

Parameters:

key - Key of the property

Returns:

Name of the specified property

Throws:

ObjectConfigurationException

getFieldDescription

String getFieldDescription(String key)
                           throws ObjectConfigurationException

Retrieves the description of a property with the specified key

Parameters:

key - Key of the property

Returns:

Description of the specified property

Throws:

ObjectConfigurationException

getFieldType

int getFieldType(String key)
                 throws ObjectConfigurationException

Retrieves the type of the property with the specified key

Parameters:

key - Key of the property

Returns:

Type of the specified property

Throws:

ObjectConfigurationException

getFieldDefault

String getFieldDefault(String key)
                       throws ObjectConfigurationException

Retrieves the default value for property with specified key

Parameters:

key - Key of the property

Returns:

Default value of the specified property

Throws:

ObjectConfigurationException

getFieldValues

Map getFieldValues(String key)
                   throws ObjectConfigurationException

Retrieves a map of available values for property with the specified key. e.g select list values

Parameters:

key - Key of the property

Returns:

List valid name/value pairs for the specified property

Throws:

ObjectConfigurationException

getFieldValuesHtmlEncoded

Map getFieldValuesHtmlEncoded(String key)
                              throws ObjectConfigurationException

Retrieves a map of available values for property with the specified key. e.g select list values. However, keys and values are html encoded in the returned map.

Parameters:

key -

Returns:

List valid name/value pairs for the specified property - html encoded

Throws:

ObjectConfigurationException

getFieldKeys

String[] getFieldKeys()

All the property keys for this configuration.

Returns:

Property keys

getEnabledFieldKeys

String[] getEnabledFieldKeys()

The enabled property keys for this configuration.

Returns:

Property keys

Since:

28 Aug 2007 for JIRA v3.11

isEnabled

boolean isEnabled(String key)

Is a particular property enabled at the moment - may be a runtime check.

Parameters:

key - the property's key.

Returns:

true if the property is enabled in the current context

Since:

28 Aug 2007 for JIRA v3.11

getDescription

String getDescription(Map params)

The Description of this instance of an Object Configuration

Parameters:

params - Params used to derive

Returns:

Description

allFieldsHidden

boolean allFieldsHidden()

Determines if there are any non-hidden fields.

Returns:

true if there are no fields or all fields are hidden

isI18NValues

boolean isI18NValues(String key)