uk.org.ogsadai.activity
Interface ActivityConfiguration

All Known Implementing Classes:

AddAndIndexFileActivityConfiguration, PhysicalSchemaFileActivityConfiguration

public interface ActivityConfiguration

An ActivityConfiguration object encapsulates configuration information relating to a single Activity. It is optional whether or not an Activity makes use of an ActivityConfiguration object. If so, the Activity must implement the ActivityConfigurationCreator interface, which defines a factory method responsible for creating the appropriate ActivityConfiguration object.

As well as implementing the initialise method, an ActivityConfiguration implementation should provide appropriate methods for accessing the configuration information in a convenient manner. These will be used by the Activity that is being configured.

Author:

The OGSA-DAI Project Team

See Also:

Activity.getActivityConfiguration(), ActivityConfigurationCreator, ActivityConfigurationException

initialise

public void initialise(org.w3c.dom.Document document)
                throws ActivityConfigurationException

Parses the configuration document, initialising any fields that are necessary for the accessor methods to operate. This method is called by the ActivityCreator class.

Parameters:

document - The Document containing the activity configuration information.

Throws:

ActivityConfigurationException - If there is a problem initialising the ActivityConfiguration object. This may be caused by the document containing invalid information, or perhaps by a system problem within the initialisation code.