internal package Foswiki::EngineException

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::EngineException is a Error

Exception used to raise an engine related error. This exception has the following fields:

• status - status code to send to client
• reason a text string giving the reason for the refusal.

ClassMethod new( $status, $reason [, $response] )

• $status - status code to send to client
• $reason - string reason for failure
• $response - custom Foswiki::Response object to be sent to client. Optional.

All the above fields are accessible from the object in a catch clause in the usual way e.g. $e→{status} and $e→{reason}

ObjectMethod stringify() → $string

Generate a summary string. This is mainly for debugging.