net.sf.wfnm
Interface NavigationManager

All Superinterfaces:

OwnershipConst, Serializable

All Known Implementing Classes:

NavigationManagerImpl

public interface NavigationManager

extends Serializable, OwnershipConst

The Navigation Manager interface.
Concrete implementations of this interface contain the internal status of the framework such as:

• the stack of visited webflows
• the stack of visited pages for each webflow
• ownership defined for single objects
• a lock that allow to avoid multiple cuncurrent requests
• listeners for page changed and webflow changed

Version:

1.0.6

Author:

Maurizio Albari

Field Summary

Fields inherited from interface net.sf.wfnm.OwnershipConst

GLOBAL_OWNERSHIP, NO_OWNERSHIP, OWNERSHIP_DESC, PAGE_OWNERSHIP, PREVIOUS_OWNERSHIP, WEBFLOW_OWNERSHIP, WORKING_OWNERSHIP

Method Summary

String	getCurrentPage() Gets the url of the current page.
String	getCurrentWebflow() Gets the current webflow name.
Object	getLock() Gets the synchronization lock.
String	getPreviousPage() Gets the url of the previous page.
String	getPreviousWebflow() Gets the url of the previous webflow top page.
String	getPreviousWebflow(String webflow) Gets the url of a webflow top page.
Stack	getWebflowStack() Returns the webflow stack.
boolean	isPageVisited(String url) Returns true if the page has been visited.
boolean	isWebflowVisited(String webflowName) Returns true if the webflow has been visited.
void	notifyPage(AttributeContainer container, String url, Set addedObjectSet, Set removedObjectSet) Notify that the navigation has reached a page.
void	notifyPage(AttributeContainer container, String url, String webflowName, int defaultWebflowOwnership, Set addedObjectSet, Set removedObjectSet) Notify that the navigation has reached a page of a specified webflow.
void	resetFramework(AttributeContainer container) Reset the navigation manager.
void	setLock(Object lock) Sets the synchronization lock.
void	setObjectOwnership(String objectKey, int objectOwnership) Sets the object owner.
void	setPageChangedListener(PageChangedListener pageChangedListener) Sets the page changed listener.
void	setWebflowChangedListener(WebflowChangedListener webflowChangedListener) Sets the webflow changed listener.

Method Detail

getCurrentPage

public String getCurrentPage()

Gets the url of the current page.

Returns:

the url of the current page (null=no visited page)

getCurrentWebflow

public String getCurrentWebflow()

Gets the current webflow name.

Returns:

the current webflow name (null=no webflow visited)

setLock

public void setLock(Object lock)

Sets the synchronization lock.

Parameters:

lock - the synchronization lock

getLock

public Object getLock()

Gets the synchronization lock.

Returns:

the synchronization lock

setObjectOwnership

public void setObjectOwnership(String objectKey,
                               int objectOwnership)

Sets the object owner.

Parameters:

objectKey - the object key

objectOwnership - the object ownership

setPageChangedListener

public void setPageChangedListener(PageChangedListener pageChangedListener)

Sets the page changed listener.

Parameters:

pageChangedListener - the page changed listener

isPageVisited

public boolean isPageVisited(String url)

Returns true if the page has been visited.

Parameters:

url - the url of the page

Returns:

true if the page has been visited

getPreviousPage

public String getPreviousPage()

Gets the url of the previous page.

Returns:

the url of the previous page (null=no previous page)

getPreviousWebflow

public String getPreviousWebflow()

Gets the url of the previous webflow top page.

Returns:

the url of the previous webflow top page (null=no previous webflow top page)

getPreviousWebflow

public String getPreviousWebflow(String webflow)

Gets the url of a webflow top page.

Parameters:

webflow - the webflow name

Returns:

the url of a webflow top page (null=no visited pages in the specified webflow)

setWebflowChangedListener

public void setWebflowChangedListener(WebflowChangedListener webflowChangedListener)

Sets the webflow changed listener.

Parameters:

webflowChangedListener - the webflow changed listener

getWebflowStack

public Stack getWebflowStack()

Returns the webflow stack.

Returns:

the webflow stack

isWebflowVisited

public boolean isWebflowVisited(String webflowName)

Returns true if the webflow has been visited.

Parameters:

webflowName - the webflow name

Returns:

true if the webflow has been visited

notifyPage

public void notifyPage(AttributeContainer container,
                       String url,
                       String webflowName,
                       int defaultWebflowOwnership,
                       Set addedObjectSet,
                       Set removedObjectSet)

Notify that the navigation has reached a page of a specified webflow.

Parameters:

container - the attribute container

url - the url of the page

webflowName - the webflow name

defaultWebflowOwnership - the default webflow ownership

addedObjectSet - the added object set

removedObjectSet - the removed object set

notifyPage

public void notifyPage(AttributeContainer container,
                       String url,
                       Set addedObjectSet,
                       Set removedObjectSet)

Notify that the navigation has reached a page.

Parameters:

container - the attribute container

url - the url of the page

addedObjectSet - the added object set

removedObjectSet - the removed object set

resetFramework

public void resetFramework(AttributeContainer container)

Reset the navigation manager.

Parameters:

container - the attribute container