Package org.oddjob.arooa.parsing

Interface ConfigurationOwner

All Known Implementing Classes:

ForEachJob, ForEvents, Oddjob, Oddjob.OddjobRoot

public interface ConfigurationOwner

Something, typically a component, that is able to provide editing facilities for an ArooaConfiguration.

Author:

rob

Method Summary

Modifier and Type	Method	Description
void	addOwnerStateListener(OwnerStateListener listener)	Add a listener.
ConfigurationSession	provideConfigurationSession()	Provide a ConfigurationSession.
void	removeOwnerStateListener(OwnerStateListener listener)	Remove a listener.
SerializableDesignFactory	rootDesignFactory()	Get the design factory for the configuration.
ArooaElement	rootElement()	Get the root element.

Method Details

provideConfigurationSession

ConfigurationSession provideConfigurationSession()

Provide a ConfigurationSession.

Returns:

A ConfigurationSession. May be null if no session is available.

addOwnerStateListener

void addOwnerStateListener(OwnerStateListener listener)

Add a listener.

Parameters:

listener -

removeOwnerStateListener

void removeOwnerStateListener(OwnerStateListener listener)

Remove a listener.

Parameters:

listener -

rootDesignFactory

SerializableDesignFactory rootDesignFactory()

Get the design factory for the configuration. If this is null the Oddjob Explorer won't show a DesignInside action.

Note that this is a SerializableDesignFactory so that this interface can be represented remotely.

Returns:

A DesignFactory. Must not be null if a ConfigurationSession is available.

rootElement

ArooaElement rootElement()

Get the root element.

Returns:

The root element of the configuration. Must not be null if a ConfigurationSession is available.