NAME

Solstice::State::PageFlow - Represents a set of transitions that flow a user through a graph of Solstice::State::Node objects.

SYNOPSIS

use Solstice::State::PageFlow;

my $transition = new Solstice::State::PageFlow($appName, $flowName, $entrance);

$pageFlow->addTransition($transition);

Methods

new($appName, $flowName, $entrance)

Creates a new Solstice::State::PageFlow object.

$appName - the name of the application. $flowName - the name of the page flow. $entrance - the entrance state of the flow.

returns - a new page flow object.

addFailover($startState, $stage, $failoverState)

Adds a failover state to go to when stage $stage fails.

getFailover($startState, $stage)

Gets the name of the state to fail over to given the lifecycle stage.

getName()

Returns the name of the page flow.

getApplicationName()

Returns the name of the application this flow belongs to.

getEntrance()

Returns the name of the entrance state

addTransition($transition)

Adds a transition to the page flow.

$startState - the state name that the transition begins at. $transition - the Solstice::State::Transition object to add.

getTransition($state, $action)

Returns the transition from state via action.

getTransitions()

Returns a hash of hashes of transitions keyed by their start state and action.

COPYRIGHT

Copyright 1998-2007 Office of Learning Technologies, University of Washington

Licensed under the Educational Community License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.opensource.org/licenses/ecl1.php

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.