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

Interface PageFlowDefinitionRegistry

All Known Implementing Classes:

MapPageFlowDefinitionRegistry, RepositoryMapPageFlowDefinitionRegistry

public interface PageFlowDefinitionRegistry

Page Flow Definition Registry abstraction which is responsible for retrieval, removing or clearing PageFlowDefinition instances.

Method Summary

Modifier and Type	Method	Description
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.

Method Detail

getPageFlowDefinition

PageFlowDefinition getPageFlowDefinition(String flowId)
                                  throws PageFlowException

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

Parameters:

flowId - the identifier of the PageFlowDefinition

Returns:

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

Throws:

PageFlowException - if any exception occurs

removePageFlowDefinitionByUuid

void removePageFlowDefinitionByUuid(String uuid)
                             throws PageFlowException

Remove the PageFlowDefinition by the optional uuid of the PageFlowDefinition.

Parameters:

uuid - the optional UUID value of the PageFlowDefinition

Throws:

PageFlowException - if any exception occurs

removePageFlowDefinition

void removePageFlowDefinition(String flowId)
                       throws PageFlowException

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

Parameters:

flowId - the identifier value of the PageFlowDefinition

Throws:

PageFlowException - if any exception occurs

clearPageFlowDefinitions

void clearPageFlowDefinitions()
                       throws PageFlowException

Clear all the registered PageFlowDefinitions in the registry.

Throws:

PageFlowException - if any exception occurs