Solstice::State::Transition - Representation of the transition between Solstice::State objects.


Solstice documentation  | view source Contained in the Solstice distribution.

Index


NAME

Top

Solstice::State::Transition - Representation of the transition between Solstice::State objects.

SYNOPSIS

Top

use Solstice::State::Transition;

my $transition = new Solstice::State::Transition( $action, $targetState, $pageflow, {update => $update, revert => $revert, freshen => $freshen, commit => $commit, validate => $validate});

$pageFlow->addTransition($transition);

Methods

new ($action, $targetState, $onBack, $pageflow, {update => $update, revert => $revert, freshen => $freshen, commit => $commit, validate => $validate})

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

$action - the keyword on which to transition. $targetState - the name of the state to transition to. $onBack - the error message for using the back button (undef if allowed). $pageflow - global transtions can specify what page flow they will start in $update - whether to update on transition. $revert - whether to revert on transition. $freshen - whether to freshen data on transition. $commit - whether to commit data on transition. $validate - whether to validate on transition.

returns - a new state transition object.

getName()

returns - the name of the transition (the action)

getBackErrorMessage()

returns - the error message for using the back button (undef if allowed).

requiresUpdate()

returns - whether the transition requires an update.

requiresRevert()

returns - whether the transition requires a revert.

requiresFresh()

returns - whether the transition requires a freshen.

requiresCommit()

returns - whether the transition requires a commit.

requiresValidation()

returns - whether the transition requires a validation.

COPYRIGHT

Top


Solstice documentation  | view source Contained in the Solstice distribution.