org.oddjob.arooa.parsing
Interface ConfigurationSession

All Known Implementing Classes:
ConfigConfigurationSession, ContextConfigurationSession, HandleConfigurationSession

public interface ConfigurationSession

Something that is able to provide everything required to edit an ArooaConfiguration.

A ConfigurationSession is intended to be a minimal derivation of an ArooaSession that is able to provide enough to edit a configuration either locally or on a remote server.

Author:
rob

Method Summary
 void addSessionStateListener(SessionStateListener listener)
          Add a SessionStateListener listener.
 DragPoint dragPointFor(Object component)
          Provide a DragPoint for the given component.
 ArooaDescriptor getArooaDescriptor()
          Get the ArooaDescriptor for editing the configuration.
 boolean isModified()
          Has the configuration been modified.
 void removeSessionStateListener(SessionStateListener listener)
          Remove a SessionStateListener listener.
 void save()
          Save the configuration.
 

Method Detail

dragPointFor

DragPoint dragPointFor(Object component)
Provide a DragPoint for the given component.

Parameters:
component - The component.
Returns:
A DragPoint, or null if the component is not a member of the session.

isModified

boolean isModified()
Has the configuration been modified.

Returns:
true/false. True if modified.

addSessionStateListener

void addSessionStateListener(SessionStateListener listener)
Add a SessionStateListener listener.

Parameters:
listener - The listener.

removeSessionStateListener

void removeSessionStateListener(SessionStateListener listener)
Remove a SessionStateListener listener.

Parameters:
listener - The listener.

save

void save()
          throws ArooaParseException
Save the configuration.

Throws:
ArooaParseException

getArooaDescriptor

ArooaDescriptor getArooaDescriptor()
Get the ArooaDescriptor for editing the configuration.

Returns:
An ArooaDescriptor. Never Null.