Package org.onehippo.forge.pageflow.core.rt

Interface PageFlow

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultPageFlow
public interface PageFlow extends Serializable
Page Flow runtime abstraction.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Compares the specified object with this PageFlow for equality.
    Object
    getAttribute(String name)
    Find and return the attribute model object of this PageFlow by the name.
    Map<String,Object>
    getAttributeMap()
    Return an unmodifiable attributes map of this PageFlow.
    String
    getId()
    Return the identifier of the PageFlow instance.
    PageState
    getPageState()
    Return the current PageState instance in the PageFlow.
    List<PageState>
    getPageStates()
    Return an unmodifiable list of the PageState of this PageFlow.
    int
    hashCode()
    Returns the hash code value for this PageFlow.
    boolean
    isComplete()
    Return true if this PageFlow instance is completed.
    boolean
    isStarted()
    Return true if this PageFlow instance has started.
    boolean
    isStopped()
    Return true if this PageFlow instance has stopped.
    void
    sendEvent(String event)
    Send an event to the PageFlow, which might cause a Page Transition as a result.
    void
    setAttribute(String name, Object model)
    Set the attribute by the name on this PageFlow.
    void
    start()
    Start this PageFlow instance.
    void
    stop()
    Stop this PageFlow instance.

  • Method Details

    • getId

      String getId()
      Return the identifier of the PageFlow instance.
      Returns:
      the identifier of the PageFlow instance

    • isStarted

      boolean isStarted()
      Return true if this PageFlow instance has started.
      Returns:
      true if this PageFlow instance has started

    • start

      void start() throws PageFlowException
      Start this PageFlow instance.
      Throws:
      PageFlowException - if it can't start

    • isStopped

      boolean isStopped()
      Return true if this PageFlow instance has stopped.
      Returns:
      true if this PageFlow instance has stopped

    • stop

      void stop() throws PageFlowException
      Stop this PageFlow instance.
      Throws:
      PageFlowException - if it can't stop

    • isComplete

      boolean isComplete() throws PageFlowException
      Return true if this PageFlow instance is completed.
      Returns:
      true if this PageFlow instance is completed
      Throws:
      PageFlowException - if any exception occurs

    • getPageState

      PageState getPageState() throws PageFlowException
      Return the current PageState instance in the PageFlow.
      Returns:
      the current PageState instance in the PageFlow
      Throws:
      PageFlowException - if any exception occurs

    • sendEvent

      void sendEvent(String event) throws PageFlowException
      Send an event to the PageFlow, which might cause a Page Transition as a result.
      Parameters:
      event - event
      Throws:
      PageFlowException - if any exception occurs

    • getPageStates

      List<PageState> getPageStates() throws PageFlowException
      Return an unmodifiable list of the PageState of this PageFlow.
      Returns:
      an unmodifiable list of the PageState of this PageFlow
      Throws:
      PageFlowException - if any exception occurs

    • getAttribute

      Object getAttribute(String name) throws PageFlowException
      Find and return the attribute model object of this PageFlow by the name. Return null if not found.
      Parameters:
      name - attribute name
      Returns:
      the attribute model object of this PageFlow by the name, null if not found
      Throws:
      PageFlowException - if any exception occurs

    • setAttribute

      void setAttribute(String name, Object model) throws PageFlowException
      Set the attribute by the name on this PageFlow.
      Parameters:
      name - attribute name
      model - attribute model object
      Throws:
      PageFlowException - if any exception occurs

    • getAttributeMap

      Map<String,Object> getAttributeMap() throws PageFlowException
      Return an unmodifiable attributes map of this PageFlow.
      Returns:
      an unmodifiable attributes map of this PageFlow
      Throws:
      PageFlowException - if any exception occurs

    • equals

      boolean equals(Object o)
      Compares the specified object with this PageFlow for equality.
      Overrides:
      equals in class Object
      Parameters:
      o - the object to be compared for equality with this PageFlow
      Returns:
      true if the specified object is equal to this PageFlow

    • hashCode

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