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.
 java.lang.String getDescription(java.util.Map params)
          The Description of this instance of an Object Configuration
 java.lang.String[] getEnabledFieldKeys()
          The enabled property keys for this configuration.
 java.lang.String getFieldDefault(java.lang.String key)
          Retrieves the default value for property with specified key
 java.lang.String getFieldDescription(java.lang.String key)
          Retrieves the description of a property with the specified key
 java.lang.String[] getFieldKeys()
          All the property keys for this configuration.
 java.lang.String getFieldName(java.lang.String key)
          Retrieves the name of a property with the specified key
 int getFieldType(java.lang.String key)
          Retrieves the type of the property with the specified key
 java.util.Map getFieldValues(java.lang.String key)
          Retrieves a map of available values for property with the specified key.
 void init(java.util.Map params)
          Initialises the object with some parameters
 boolean isEnabled(java.lang.String key)
          Is a particular property enabled at the moment - may be a runtime check.
 boolean isI18NValues(java.lang.String key)
           
 

Method Detail

init

void init(java.util.Map params)
Initialises the object with some parameters

Parameters:
params - Map of initialisation params

getFieldName

java.lang.String getFieldName(java.lang.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

java.lang.String getFieldDescription(java.lang.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(java.lang.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

java.lang.String getFieldDefault(java.lang.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

java.util.Map getFieldValues(java.lang.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

getFieldKeys

java.lang.String[] getFieldKeys()
All the property keys for this configuration.

Returns:
Property keys

getEnabledFieldKeys

java.lang.String[] getEnabledFieldKeys()
The enabled property keys for this configuration.

Returns:
Property keys
Since:
28 Aug 2007 for JIRA v3.11

isEnabled

boolean isEnabled(java.lang.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

java.lang.String getDescription(java.util.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(java.lang.String key)


Copyright © 2002-2010 Atlassian. All Rights Reserved.