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

Interface PageFlowDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultPageFlowDefinition
public interface PageFlowDefinition extends Serializable
Page Flow Definition abstraction.

  • Method Details

    • getId

      String getId()
      Return the identifier of a PageFlowDefinition.
      Returns:
      the identifier of a PageFlowDefinition

    • getName

      String getName()
      Return the (human readable) name of a PageFlowDefinition.
      Returns:
      the (human readable) name of a PageFlowDefinition

    • getUuid

      String getUuid()
      Return the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR.
      Returns:
      the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR

    • getPageStateDefinitions

      List<PageStateDefinition> getPageStateDefinitions()
      Return an unmodifiable list of PageStateDefinitions of this PageFlowDefinition.
      Returns:
      an unmodifiable list of PageStateDefinitions of this PageFlowDefinition

    • getPageTransitionDefinitions

      List<PageTransitionDefinition> getPageTransitionDefinitions()
      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.

      Returns:
      an unmodifiable list of the global PageTransitionDefinitions of this PageFlowDefinition

    • equals

      boolean equals(Object o)
      Compares the specified object with this PageFlowDefinition for equality.
      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

      int hashCode()
      Returns the hash code value for this PageFlowDefinition.
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this PageFlowDefinition