com.atlassian.configurable
Interface ObjectConfigurationFactory

All Known Implementing Classes:

XMLObjectConfigurationFactory

public interface ObjectConfigurationFactory

This class retrieves an Object Configuration with a particular id. The Object Configuration must be unique as a user will set there own parameters on the object during its lifetime.

Method Summary

ObjectConfiguration	getObjectConfiguration(String id, Map userParams) This function retrieves an ObjectConfiguration based on a specified identifier, N.B.
boolean	hasObjectConfiguration(String id) Does this factory know about an ObjectConfiguration with the specified id
void	loadObjectConfiguration(String xmlFile, String id, ClassLoader classLoader)
void	loadObjectConfigurationFromElement(org.dom4j.Element element, ObjectDescriptor od, String id, ClassLoader classLoader)

Method Detail

hasObjectConfiguration

boolean hasObjectConfiguration(String id)

Does this factory know about an ObjectConfiguration with the specified id

Parameters:

id - Identifier for the object configuration to retrieve.

Returns:

object configuration is available.

getObjectConfiguration

ObjectConfiguration getObjectConfiguration(String id,
                                           Map userParams)
                                           throws ObjectConfigurationException

This function retrieves an ObjectConfiguration based on a specified identifier, N.B. must be muttable

Parameters:

id - Identifier for the object configuration to retrieve.

Returns:

a ObjectConfiguration

Throws:

ObjectConfigurationException

loadObjectConfiguration

void loadObjectConfiguration(String xmlFile,
                             String id,
                             ClassLoader classLoader)
                             throws ObjectConfigurationException

Throws:

ObjectConfigurationException

loadObjectConfigurationFromElement

void loadObjectConfigurationFromElement(org.dom4j.Element element,
                                        ObjectDescriptor od,
                                        String id,
                                        ClassLoader classLoader)