pt.digitalis.dif.controller.interfaces
Interface INavigationHistory

All Known Implementing Classes:

NavigationHistoryImpl

public interface INavigationHistory

Tracks all navigation history for a single session

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

2008/07/20

Method Summary

void	addBreadcrumb(Breadcrumb crumb) Adds a breadcrumb to the history
void	addStage(IStageInstance stage) Adds a stage to the history
void	cleanUpAfterLogout(IDIFSession session) Cleans up the navigation history after a logout process.
List<Breadcrumb>	getHistoryFirstAccess()
List<Breadcrumb>	getHistoryLastAccessed()
Breadcrumb	getPreviousForByFirstAccess(String stageToFindPrevious) Finds the previous breadcrumb for a given stage by first access
Breadcrumb	getPreviousForByLastAccess(String stageToFindPrevious) Finds the previous breadcrumb for a given stage by last access
boolean	isEmpty()
void	removeStage(String stage) Removes a stage from the history

Method Detail

addBreadcrumb

void addBreadcrumb(Breadcrumb crumb)

Adds a breadcrumb to the history

Parameters:

crumb - the crumb to add

addStage

void addStage(IStageInstance stage)

Adds a stage to the history

Parameters:

stage - the stage to add

cleanUpAfterLogout

void cleanUpAfterLogout(IDIFSession session)

Cleans up the navigation history after a logout process. Stages that are no longer accessible are discarded from the list. Will parse if the current user can access each stage, or if no user logged if the stages are publicly accessible.

Parameters:

session - the current user session

getHistoryFirstAccess

List<Breadcrumb> getHistoryFirstAccess()

Returns:

all current gathered breadcrumbs ordered by first access time

getHistoryLastAccessed

List<Breadcrumb> getHistoryLastAccessed()

Returns:

all current gathered breadcrumbs ordered by last access time

getPreviousForByFirstAccess

Breadcrumb getPreviousForByFirstAccess(String stageToFindPrevious)

Finds the previous breadcrumb for a given stage by first access

Parameters:

stageToFindPrevious -

Returns:

the previous stage ID (for the given stage)

getPreviousForByLastAccess

Breadcrumb getPreviousForByLastAccess(String stageToFindPrevious)

Finds the previous breadcrumb for a given stage by last access

Parameters:

stageToFindPrevious -

Returns:

the previous stage ID (for the given stage)

isEmpty

boolean isEmpty()

Returns:

T is the history is empty

removeStage

void removeStage(String stage)

Removes a stage from the history

Parameters:

stage - the stage to remove