Steve Purkis > OpenFrame-WebApp-0.04 > OpenFrame::WebApp::Segment::Decline

Download:
OpenFrame-WebApp-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.2   Source  

NAME ^

OpenFrame::WebApp::Segment::Decline - abstract class for declining to process a pipeline.

SYNOPSIS ^

  # abstract class - cannot be used directly

  use Pipeline;
  use OpenFrame::WebApp::Segment::Decline::Something;

  my $sub_pipe = new Pipeline;

  my $decliner = new OpenFrame::WebApp::Segment::Decline::Something;
  $sub_pipe->add_segment( $decliner, ... );

  my $pipe = new Pipeline;
  $pipe->add_segment( ..., $sub_pipe, ... );

  ...

  $pipe->dispatch;

  # sub_pipe will not be executed if Decline::Something's
  # should_decline is true.

DESCRIPTION ^

The OpenFrame::WebApp::Segment::User class provides a standard way of declining to continue processing a Pipeline.

This class inherits its interface from Pipeline::Segment.

METHODS ^

$production = $obj->dispatch

Returns a Pipeline::Production with $self->message if $self->should_decline is true.

$boolean = $obj->should_decline

abstract method.

$msg = $obj->message

message to decline with. defaults to 'declined'.

AUTHOR ^

Steve Purkis <spurkis@epn.nu>

COPYRIGHT ^

Copyright (c) 2003 Steve Purkis. All rights reserved. Released under the same license as Perl itself.

SEE ALSO ^

Pipeline::Segment

syntax highlighting: