public interface ObjectConfiguration
Modifier and Type | Method and Description |
---|---|
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
|
String |
getFieldTypeName(String key)
Retrieves the name of 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) |
void init(Map params)
params
- Map of initialisation paramsString getFieldName(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
String getFieldDescription(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
int getFieldType(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
String getFieldTypeName(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
String getFieldDefault(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
Map getFieldValues(String key) throws ObjectConfigurationException
key
- Key of the propertyObjectConfigurationException
Map getFieldValuesHtmlEncoded(String key) throws ObjectConfigurationException
key
- ObjectConfigurationException
String[] getFieldKeys()
String[] getEnabledFieldKeys()
boolean isEnabled(String key)
key
- the property's key.String getDescription(Map params)
params
- Params used to deriveboolean allFieldsHidden()
boolean isI18NValues(String key)
Copyright © 2002-2023 Atlassian. All Rights Reserved.