Package org.onehippo.forge.pageflow.core.def.impl

Class MapPageFlowDefinitionRegistry

java.lang.Object

org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry

All Implemented Interfaces:

PageFlowDefinitionRegistry

Direct Known Subclasses:

RepositoryMapPageFlowDefinitionRegistry

public class MapPageFlowDefinitionRegistry
extends Object
implements PageFlowDefinitionRegistry

Generic purpose Map based PageFlowDefinitionRegistry implementation.

Constructor Summary

Constructors

Constructor	Description
MapPageFlowDefinitionRegistry()
MapPageFlowDefinitionRegistry(Map<String,PageFlowDefinition> pageFlowDefMap)

Method Summary

Modifier and Type	Method	Description
void	addPageFlowDefinition(PageFlowDefinition pageFlowDef)
void	clearPageFlowDefinitions()	Clear all the registered PageFlowDefinitions in the registry.
PageFlowDefinition	getPageFlowDefinition(String flowId)	Retrieve the PageFlowDefinition by the identifier (flowId).
void	removePageFlowDefinition(String flowId)	Remove the PageFlowDefinition by the identifier (flowId) of the PageFlowDefinition.
void	removePageFlowDefinitionByUuid(String uuid)	Remove the PageFlowDefinition by the optional uuid of the PageFlowDefinition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapPageFlowDefinitionRegistry

public MapPageFlowDefinitionRegistry()

MapPageFlowDefinitionRegistry

public MapPageFlowDefinitionRegistry(Map<String,PageFlowDefinition> pageFlowDefMap)

Method Detail

getPageFlowDefinition

public PageFlowDefinition getPageFlowDefinition(String flowId)
                                         throws PageFlowException

Description copied from interface: PageFlowDefinitionRegistry

Retrieve the PageFlowDefinition by the identifier (flowId). Return null if there's no PageFlowDefinition found by the identifier.

Specified by:

getPageFlowDefinition in interface PageFlowDefinitionRegistry

Parameters:

flowId - the identifier of the PageFlowDefinition

Returns:

the PageFlowDefinition identified by flowId, or null if not found.

Throws:

PageFlowException - if any exception occurs

addPageFlowDefinition

public void addPageFlowDefinition(PageFlowDefinition pageFlowDef)
                           throws PageFlowException

Throws:

PageFlowException

removePageFlowDefinitionByUuid

public void removePageFlowDefinitionByUuid(String uuid)
                                    throws PageFlowException

Description copied from interface: PageFlowDefinitionRegistry

Remove the PageFlowDefinition by the optional uuid of the PageFlowDefinition.

Specified by:

removePageFlowDefinitionByUuid in interface PageFlowDefinitionRegistry

Parameters:

uuid - the optional UUID value of the PageFlowDefinition

Throws:

PageFlowException - if any exception occurs

removePageFlowDefinition

public void removePageFlowDefinition(String flowId)
                              throws PageFlowException

Description copied from interface: PageFlowDefinitionRegistry

Remove the PageFlowDefinition by the identifier (flowId) of the PageFlowDefinition.

Specified by:

removePageFlowDefinition in interface PageFlowDefinitionRegistry

Parameters:

flowId - the identifier value of the PageFlowDefinition

Throws:

PageFlowException - if any exception occurs

clearPageFlowDefinitions

public void clearPageFlowDefinitions()
                              throws PageFlowException

Description copied from interface: PageFlowDefinitionRegistry

Clear all the registered PageFlowDefinitions in the registry.

Specified by:

clearPageFlowDefinitions in interface PageFlowDefinitionRegistry

Throws:

PageFlowException - if any exception occurs