.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Jifty::Result 3pm"
.TH Jifty::Result 3pm "2010-09-25" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Jifty::Result \- Outcome of running a Jifty::Action
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Jifty::Result\*(C'\fR encapsulates the outcome of running a
Jifty::Action.  Results are also stored on the framework's
Jifty::Response object.
.SS "new"
.IX Subsection "new"
Construct a new action result.  This is done automatically when the
action is created, and can be accessed via the
\&\*(L"result\*(R" in Jifty::Action.
.SS "failure [\s-1BOOL\s0]"
.IX Subsection "failure [BOOL]"
Gets or sets if the action succeeded or failed.
.SS "success [\s-1BOOL\s0]"
.IX Subsection "success [BOOL]"
Gets or sets if the action succeeded or failed \*(-- this is an
alternate interface from \f(CW\*(C`failure\*(C'\fR but has the same effect.
.SS "action_class [\s-1MESSAGE\s0]"
.IX Subsection "action_class [MESSAGE]"
Returns the class for the action that this result came from.
.SS "message [\s-1MESSAGE\s0]"
.IX Subsection "message [MESSAGE]"
Gets or sets the action's response message.  This is an informational
textual description of the outcome of the action.
.SS "error [\s-1ERROR\s0]"
.IX Subsection "error [ERROR]"
Gets or sets the action's error response.  This is an informational
textual description of what went wrong with the action, overall.  This
also automatically sets the result to be a \*(L"failure\*(R".
.SS "field_error \s-1FIELD\s0 [\s-1ERROR\s0] [\s-1OPTIONS\s0]"
.IX Subsection "field_error FIELD [ERROR] [OPTIONS]"
Gets or sets the error string for a specific field on the action.
This also automatically sets the result to be a failure.  \f(CW\*(C`OPTIONS\*(C'\fR
is an optional set of key-value pairs; the only currently supported
option is \f(CW\*(C`force\*(C'\fR, which sets the \*(L"ajax_force_validate\*(R" for this
field.
.SS "field_errors"
.IX Subsection "field_errors"
Returns a hash which maps argument
name to error.
.SS "field_warning \s-1FIELD\s0 [\s-1WARNING\s0] [\s-1OPTIONS\s0]"
.IX Subsection "field_warning FIELD [WARNING] [OPTIONS]"
Gets or sets the warning string for a specific field on the
action. \f(CW\*(C`OPTIONS\*(C'\fR is an optional set of key-value pairs; the only
currently supported option is \f(CW\*(C`force\*(C'\fR, which sets the
\&\*(L"ajax_force_validate\*(R" for this field.
.SS "field_warnings"
.IX Subsection "field_warnings"
Returns a hash which maps argument
name to warning.
.SS "ajax_force_validate \s-1FIELD\s0 [\s-1VALUE\s0]"
.IX Subsection "ajax_force_validate FIELD [VALUE]"
Gets or sets the flag which determines if warnings and errors are set
using ajax validation, even if the field is empty.  By default,
validation warnings and errors are \fInot\fR shown for empty fields, as
yelling to users about mandatory fields they've not gotten to yet is
poor form.  You can use this method to force ajax errors to show even
on empty fields.
.SS "field_canonicalization_note \s-1FIELD\s0 [\s-1NOTE\s0]"
.IX Subsection "field_canonicalization_note FIELD [NOTE]"
Gets or sets a canonicalization note for a specific field on the action.
.SS "field_canonicalization_notes"
.IX Subsection "field_canonicalization_notes"
Returns a hash which maps argument
name to canonicalization notes.
.SS "content [\s-1KEY\s0 [, \s-1VALUE\s0]]"
.IX Subsection "content [KEY [, VALUE]]"
Gets or sets the content \f(CW\*(C`KEY\*(C'\fR.  This is used when actions need to
return values.  If not \f(CW\*(C`KEY\*(C'\fR is passed, it returns an anonymous hash
of all of the \f(CW\*(C`KEY\*(C'\fR and \f(CW\*(C`VALUE\*(C'\fR pairs.
.SS "as_hash"
.IX Subsection "as_hash"
This returns the results as a hash to be given directly to the end user
(usually via \s-1REST\s0 or webservices). The difference between
\&\f(CW\*(C`$result\->as_hash\*(C'\fR and \f(CW%$result\fR is that the latter will expand
everything as deeply as possible. The former won't inflate \f(CW\*(C`refers_to\*(C'\fR
columns, among other things.