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

Interface PageStateDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultPageStateDefinition

public interface PageStateDefinition
extends Serializable

Page State Definition abstraction which is part of a Page Flow Definition.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the specified object with this PageStateDefinition for equality.
String	getId()	Return the identifier of the PageStateDefinition.
Map<String,String>	getMetadata()	Return an unmodifiable metadata map of the PageStateDefinition.
String	getName()	Return the (human readable) name of the PageStateDefinition.
List<PageTransitionDefinition>	getPageTransitionDefinitions()	Return an unmodifiable list of the PageStateDefinition level PageTransitionDefinitions.
String	getPath()	Return the logical path info of the PageStateDefinition.
int	hashCode()	Returns the hash code value for this PageStateDefinition.

Method Detail

getId

String getId()

Return the identifier of the PageStateDefinition.

Returns:

the identifier of the PageStateDefinition

getName

String getName()

Return the (human readable) name of the PageStateDefinition.

Returns:

the (human readable) name of the PageStateDefinition

getPath

String getPath()

Return the logical path info of the PageStateDefinition.

This path info must be translated into a physical URI or client-side route information by an application. In the definition level, this path info doesn't imply any physical translations by itself.

Returns:

the logical path info of the PageStateDefinition

getMetadata

Map<String,String> getMetadata()

Return an unmodifiable metadata map of the PageStateDefinition.

Returns:

an unmodifiable metadata map of the PageStateDefinition

getPageTransitionDefinitions

List<PageTransitionDefinition> getPageTransitionDefinitions()

Return an unmodifiable list of the PageStateDefinition level PageTransitionDefinitions.

Returns:

an unmodifiable list of the PageStateDefinition level PageTransitionDefinitions

equals

boolean equals(Object o)

Compares the specified object with this PageStateDefinition for equality.

Overrides:

equals in class Object

Parameters:

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

Returns:

true if the specified object is equal to this PageStateDefinition

hashCode

int hashCode()

Returns the hash code value for this PageStateDefinition.

Overrides:

hashCode in class Object

Returns:

the hash code value for this PageStateDefinition