Summary: Methods | [Expand All]
public interface

ObjectConfigurationFactory

com.atlassian.configurable.ObjectConfigurationFactory
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
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(Element element, ObjectDescriptor od, String id, ClassLoader classLoader)

Public Methods

public ObjectConfiguration getObjectConfiguration (String id, Map userParams)

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

public 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.

public void loadObjectConfiguration (String xmlFile, String id, ClassLoader classLoader)

Throws
ObjectConfigurationException

public void loadObjectConfigurationFromElement (Element element, ObjectDescriptor od, String id, ClassLoader classLoader)