net.sf.wfnm
Interface NavigationContext

All Known Implementing Classes:

NavigationContextImpl

public interface NavigationContext

Defines the navigation context.
Concrete implementations of this interface allow to harvest information such as:

• keys of objects inserted/removed into/from the http session
• the webflow name and its default ownership, if any new is created
• the ownership of single objects, if any have been defined
• whether the current page has be to ignored from server side history
• whether the framework has to be resetted
• if a previous webflow has to be forced

Version:

1.0.6

Author:

Maurizio Albari

Method Summary

void	addOwnership(String objectKey, int objectOwnership) Adds a deferred ownership.
boolean	isFrameworkToReset() Returns true if the framework has to be resetted.
boolean	isIgnorePage() Indicates if the page has to be ignored.
void	notifyPage(AttributeContainer container, String url) Notify that a page has been reached.
void	removeAttribute(AttributeContainer container, String objectKey) Removes an attribute.
void	resetFramework() Reset the Webflow Navigation Manager framework.
void	setAttribute(AttributeContainer container, String objectKey) Sets an attribute.
void	setDefaultOwnership(int defaultOwnership) Sets the webflow default ownership.
void	setIgnorePage(boolean ignorePage) Sets whether the page has to be ignored.
void	setPreviousWebflowToForce(String webflowName) Force the previous webflow.
void	setWebflowName(String webflowName) Sets the webflow name.

Method Detail

setAttribute

public void setAttribute(AttributeContainer container,
                         String objectKey)

Sets an attribute.

Parameters:

container - the attribute container

objectKey - the object key

setDefaultOwnership

public void setDefaultOwnership(int defaultOwnership)

Sets the webflow default ownership.

Parameters:

defaultOwnership - the webflow default ownership

isFrameworkToReset

public boolean isFrameworkToReset()

Returns true if the framework has to be resetted.

Returns:

true if the framework has to be resetted

setIgnorePage

public void setIgnorePage(boolean ignorePage)

Sets whether the page has to be ignored.

Parameters:

ignorePage - true if the page has to be ignored

isIgnorePage

public boolean isIgnorePage()

Indicates if the page has to be ignored.

Returns:

true if the page has to be ignored

setPreviousWebflowToForce

public void setPreviousWebflowToForce(String webflowName)

Force the previous webflow.

Parameters:

webflowName - the previous webflow to force

setWebflowName

public void setWebflowName(String webflowName)

Sets the webflow name.

Parameters:

webflowName - the webflow name

addOwnership

public void addOwnership(String objectKey,
                         int objectOwnership)

Adds a deferred ownership.

Parameters:

objectKey - the object key

objectOwnership - the object ownership

notifyPage

public void notifyPage(AttributeContainer container,
                       String url)

Notify that a page has been reached.

Parameters:

container - the attribute container

url - the url of the page

removeAttribute

public void removeAttribute(AttributeContainer container,
                            String objectKey)

Removes an attribute.

Parameters:

container - the attribute container

objectKey - the object key to remove

resetFramework

public void resetFramework()

Reset the Webflow Navigation Manager framework.