1head	1.1;
2access;
3symbols;
4locks; strict;
5comment	@# @;
6
7
81.1
9date	2010.05.29.14.44.11;	author TWikiContributor;	state Exp;
10branches;
11next	;
12
13
14desc
15@buildrelease
16@
17
18
191.1
20log
21@buildrelease
22@
23text
24@---+ Package =TWiki::EngineException=
25
26Exception used to raise an engine related error. This exception has the
27following fields:
28   * =status= - status code to send to client
29   * =reason= a text string giving the reason for the refusal.
30
31
32%TOC%
33
34---++ ClassMethod *new* <tt>($status,$reason[,$response])</tt>
35
36   * =$status= - status code to send to client
37   * =$reason= - string reason for failure
38   * =$response= - custom TWiki::Response object to be sent to client. Optional.
39
40All the above fields are accessible from the object in a catch clause
41in the usual way e.g. =$e->{status}= and =$e->{reason}=
42
43
44
45---++ ObjectMethod *stringify* <tt>() -> $string</tt>
46
47Generate a summary string. This is mainly for debugging.
48
49
50@
51