GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  WORKFLOW::EXCEPTION (3)

.ds Aq ’

NAME

Workflow::Exception - Base class for workflow exceptions

CONTENTS

VERSION

This documentation describes version 1.08 of this package

SYNOPSIS



 # Standard usage
 use Workflow::Exception qw( workflow_error );

 my $user = $wf->context->param( current_user );
 unless ( $user->check_password( $entered_password ) ) {
   workflow_error "User exists but password check failed";
 }

 # Pass a list of strings to form the message

 unless ( $user->check_password( $entered_password ) ) {
   workflow_error Bad login: , $object->login_attempted;
 }

 # Using other exported shortcuts

 use Workflow::Exception qw( configuration_error );
 configuration_error "Field foo must be a set to bar";

 use Workflow::Exception qw( validation_error );
 validation_error "Validation for field foo failed: $error";



DESCRIPTION

First, you should probably look at Exception::Class for more usage examples, why we use exceptions, what they are intended for, etc.

This is the base class for all workflow exceptions. It declares a handful of exceptions and provides shortcuts to make raising an exception easier and more readable.

METHODS

throw( @msg, [ \%params ])

This overrides <B>B>throw()<B>B> from Exception::Class to add a little syntactic sugar. Instead of:



 $exception_class->throw( message => This is my very long error message that I would like to pass,
                          param1  => Param1 value,
                          param2  => Param2 value );



You can use:



 $exception_class->throw( This is my very long error message ,
                          that I would like to pass,
                          { param1 => Param1 value,
                            param2 => Param2 value } );



And everything will work the same. Combined with the SHORTCUTS this makes for very readable code:



 workflow_error "Something went horribly, terribly, dreadfully, "
                "frightfully wrong: $@",
                { foo => bar };



condition_error

This method transforms the error to a condition error.

This exception is thrown via </mythrow> when a condition of a workflow is invalid.

configuration_error

This method transforms the error to a configuration error.

This exception is thrown via </mythrow> when configuration of a workflow is unsuccessful.

persist_error

This method transforms the error to a persistance error.

This exception is thrown via </mythrow> when the save of a workflow is unsuccessful.

validation_error

This method transforms the error to a validation error.

This exception is thrown via </mythrow> when input data or similar of a workflow is unsuccessful.

workflow_error

This method transforms the error to a workflow error.

This exception is thrown via </mythrow> when input data or similar of a workflow is unsuccessful.

SHORTCUTS

<B>Workflow::ExceptionB> - import using workflow_error

<B>Workflow::Exception::ConditionB> - import using condition_error

<B>Workflow::Exception::ConfigurationB> - import using configuration_error

<B>Workflow::Exception::PersistB> - import using persist_error

<B>Workflow::Exception::ValidationB> - import using validation_error

SEE ALSO

Exception::Class

COPYRIGHT

Copyright (c) 2003-2010 Chris Winters. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS

Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org> is the current maintainer.

Chris Winters <chris@cwinters.com>, original author.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WORKFLOW::EXCEPTION (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.