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

Class DefaultPageFlowDefinition

java.lang.Object

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

All Implemented Interfaces:

Serializable, PageFlowDefinition

public class DefaultPageFlowDefinition
extends Object
implements PageFlowDefinition

Default PageFlowDefinition model implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultPageFlowDefinition(String id, String name, String uuid)

Method Summary

Modifier and Type	Method	Description
void	addPageStateDefinition(PageStateDefinition pageStateDef)
void	addPageTransitionDefinition(PageTransitionDefinition pageTransitionDef)
void	clearPageTransitionDefinitions()
boolean	equals(Object o)	Compares the specified object with this PageFlowDefinition for equality.
String	getId()	Return the identifier of a PageFlowDefinition.
String	getName()	Return the (human readable) name of a PageFlowDefinition.
List<PageStateDefinition>	getPageStateDefinitions()	Return an unmodifiable list of PageStateDefinitions of this PageFlowDefinition.
List<PageTransitionDefinition>	getPageTransitionDefinitions()	Return an unmodifiable list of the global PageTransitionDefinitions of this PageFlowDefinition.
String	getUuid()	Return the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR.
int	hashCode()	Returns the hash code value for this PageFlowDefinition.
void	removeAllPageStateDefinitions()
boolean	removePageStateDefinition(PageStateDefinition pageStateDef)
boolean	removePageTransitionDefinition(PageTransitionDefinition pageTransitionDef)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPageFlowDefinition

public DefaultPageFlowDefinition(String id,
                                 String name,
                                 String uuid)

Method Detail

getId

public String getId()

Description copied from interface: PageFlowDefinition

Return the identifier of a PageFlowDefinition.

Specified by:

getId in interface PageFlowDefinition

Returns:

the identifier of a PageFlowDefinition

getName

public String getName()

Description copied from interface: PageFlowDefinition

Return the (human readable) name of a PageFlowDefinition.

Specified by:

getName in interface PageFlowDefinition

Returns:

the (human readable) name of a PageFlowDefinition

getUuid

public String getUuid()

Description copied from interface: PageFlowDefinition

Return the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR.

Specified by:

getUuid in interface PageFlowDefinition

Returns:

the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR

getPageStateDefinitions

public List<PageStateDefinition> getPageStateDefinitions()

Description copied from interface: PageFlowDefinition

Return an unmodifiable list of PageStateDefinitions of this PageFlowDefinition.

Specified by:

getPageStateDefinitions in interface PageFlowDefinition

Returns:

an unmodifiable list of PageStateDefinitions of this PageFlowDefinition

addPageStateDefinition

public void addPageStateDefinition(PageStateDefinition pageStateDef)

removePageStateDefinition

public boolean removePageStateDefinition(PageStateDefinition pageStateDef)

removeAllPageStateDefinitions

public void removeAllPageStateDefinitions()

getPageTransitionDefinitions

public List<PageTransitionDefinition> getPageTransitionDefinitions()

Description copied from interface: PageFlowDefinition

Return an unmodifiable list of the global PageTransitionDefinitions of this PageFlowDefinition.

The global PageTransitionDefinitions in the PageFlowDefinition level should be registered as PageTransition in each PageState at runtime even if a PageStateDefinition does not define the same PageTransitionDefinition explicitly.

This global PageTransitionDefinitions are useful if you want to define a common PageTransitionDefinition that should be applied to each PageStateDefinition without having to define it in each PageStateDefinition level.

Specified by:

getPageTransitionDefinitions in interface PageFlowDefinition

Returns:

an unmodifiable list of the global PageTransitionDefinitions of this PageFlowDefinition

addPageTransitionDefinition

public void addPageTransitionDefinition(PageTransitionDefinition pageTransitionDef)

removePageTransitionDefinition

public boolean removePageTransitionDefinition(PageTransitionDefinition pageTransitionDef)

clearPageTransitionDefinitions

public void clearPageTransitionDefinitions()

equals

public boolean equals(Object o)

Description copied from interface: PageFlowDefinition

Compares the specified object with this PageFlowDefinition for equality.

Specified by:

equals in interface PageFlowDefinition

Overrides:

equals in class Object

Parameters:

o - the object to be compared for equality with this PageFlowDefinition

Returns:

true if the specified object is equal to this PageFlowDefinition

hashCode

public int hashCode()

Description copied from interface: PageFlowDefinition

Returns the hash code value for this PageFlowDefinition.

Specified by:

hashCode in interface PageFlowDefinition

Overrides:

hashCode in class Object

Returns:

the hash code value for this PageFlowDefinition

toString

public String toString()

Overrides:

toString in class Object