com.atlassian.configurable
Interface ObjectConfigurable

All Known Subinterfaces:
JiraService, JiraServiceContainer, PortletConfiguration
All Known Implementing Classes:
AbstractMessageHandlingService, AbstractService, DebugService, ExportService, FileService, ImapService, JellyService, JiraServiceContainerImpl, MailFetcherService, MailQueueService, PopService, PortletConfigurationImpl, UnloadableJiraServiceContainer, VcsService

public interface ObjectConfigurable

This interface should be implemented by any classes that are configured using an Object Configuration.

Author:
Owen Fellows

Method Summary
 java.lang.String getDefaultProperty(java.lang.String propertyKey)
          Returns the default property value for a key
 java.lang.String getKey()
          Return the key of this object
 java.lang.Long getLongProperty(java.lang.String propertyKey)
          Returns a property of this object with the specified key as a long
 ObjectConfiguration getObjectConfiguration()
          Retrieves an object configuration object with properties that can be set
 com.opensymphony.module.propertyset.PropertySet getProperties()
          Retrieve all the specified Properties for this object
 java.lang.String getProperty(java.lang.String propertyKey)
          Returns a property of this object with the specified key
 java.lang.String getTextProperty(java.lang.String propertyKey)
          Returns a property of this object with the specified key, the property is of type text
 boolean hasProperty(java.lang.String propertyKey)
          Checks if this object has a particular property
 

Method Detail

getObjectConfiguration

ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException
Retrieves an object configuration object with properties that can be set

Returns:
ObjectConfiguration object
Throws:
ObjectConfigurationException

hasProperty

boolean hasProperty(java.lang.String propertyKey)
                    throws ObjectConfigurationException
Checks if this object has a particular property

Parameters:
propertyKey - to look for
Returns:
true If there is a value
Throws:
ObjectConfigurationException

getProperty

java.lang.String getProperty(java.lang.String propertyKey)
                             throws ObjectConfigurationException
Returns a property of this object with the specified key

Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

getTextProperty

java.lang.String getTextProperty(java.lang.String propertyKey)
                                 throws ObjectConfigurationException
Returns a property of this object with the specified key, the property is of type text

Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

getLongProperty

java.lang.Long getLongProperty(java.lang.String propertyKey)
                               throws ObjectConfigurationException
Returns a property of this object with the specified key as a long

Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

getDefaultProperty

java.lang.String getDefaultProperty(java.lang.String propertyKey)
                                    throws ObjectConfigurationException
Returns the default property value for a key

Parameters:
propertyKey - String key used to retrieve the properties default value
Returns:
Default property key
Throws:
ObjectConfigurationException

getProperties

com.opensymphony.module.propertyset.PropertySet getProperties()
                                                              throws ObjectConfigurationException
Retrieve all the specified Properties for this object

Returns:
Set of properties for this object
Throws:
ObjectConfigurationException

getKey

java.lang.String getKey()
Return the key of this object

Returns:
Key of object


Copyright © 2002-2010 Atlassian. All Rights Reserved.