.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "RT::Client::REST::Exception 3pm"
.TH RT::Client::REST::Exception 3pm "2018-12-26" "perl v5.28.1" "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"
RT::Client::REST::Exception \- Exceptions thrown by RT::Client::REST
.SH "VERSION"
.IX Header "VERSION"
version 0.56
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These are exceptions that are thrown by various RT::Client::REST
methods.
.SH "EXCEPTION HIERARCHY"
.IX Header "EXCEPTION HIERARCHY"
.IP "\fBRT::Client::REST::Exception\fR" 2
.IX Item "RT::Client::REST::Exception"
This exception is virtual \*(-- it is never thrown.  It is used to group
all the exceptions in this category.
.RS 2
.IP "\fBRT::Client::REST::OddNumberOfArgumentsException\fR" 2
.IX Item "RT::Client::REST::OddNumberOfArgumentsException"
This means that the method you called wants key-value pairs.
.IP "\fBRT::Client::REST::InvaildObjectTypeException\fR" 2
.IX Item "RT::Client::REST::InvaildObjectTypeException"
Thrown when you specify an invalid type to \f(CW\*(C`show()\*(C'\fR, \f(CW\*(C`edit()\*(C'\fR, or
\&\f(CW\*(C`search()\*(C'\fR methods.
.IP "\fBRT::Client::REST::RequiredAttributeUnsetException\fR" 2
.IX Item "RT::Client::REST::RequiredAttributeUnsetException"
An operation failed because a required attribute was not set in the object.
.IP "\fBRT::Client::REST::MalformedRTResponseException\fR" 2
.IX Item "RT::Client::REST::MalformedRTResponseException"
\&\s-1RT\s0 server sent response that we cannot parse.  This may very well mean
a bug in this client, so if you get this exception, some debug information
mailed to the author would be appreciated.
.IP "\fBRT::Client::REST::InvalidParameterValueException\fR" 2
.IX Item "RT::Client::REST::InvalidParameterValueException"
Invalid value for comments, link types, object IDs, etc.
.IP "\fBRT::Client::REST::CannotReadAttachmentException\fR" 2
.IX Item "RT::Client::REST::CannotReadAttachmentException"
Cannot read attachment (thrown from methods \*(L"\fBcomment()\fR\*(R" and \*(L"correspond\*(R").
.IP "\fBRT::Client::REST::RTException\fR" 2
.IX Item "RT::Client::REST::RTException"
This is a virtual exception and is never thrown.  It is used to group
exceptions thrown because \s-1RT\s0 server returns an error.
.RS 2
.IP "\fBRT::Client::REST::ObjectNotFoundException\fR" 2
.IX Item "RT::Client::REST::ObjectNotFoundException"
One or more of the specified objects was not found.
.IP "\fBRT::Client::REST::AuthenticationFailureException\fR" 2
.IX Item "RT::Client::REST::AuthenticationFailureException"
Incorrect username or password.
.IP "\fBRT::Client::REST::UpdateException\fR" 2
.IX Item "RT::Client::REST::UpdateException"
This is a virtual exception.  It is used to group exceptions thrown when
\&\s-1RT\s0 server returns an error trying to update an object.
.RS 2
.IP "\fBRT::Client::REST::CouldNotSetAttributeException\fR" 2
.IX Item "RT::Client::REST::CouldNotSetAttributeException"
For one or another reason, attribute could not be updated with the new
value.
.IP "\fBRT::Client::REST::InvalidEmailAddressException\fR" 2
.IX Item "RT::Client::REST::InvalidEmailAddressException"
Invalid e\-mail address specified.
.IP "\fBRT::Client::REST::AlreadyCurrentValueException\fR" 2
.IX Item "RT::Client::REST::AlreadyCurrentValueException"
The attribute you are trying to update already has this value.  I do not
know why \s-1RT\s0 insists on treating this as an exception, but since it does so,
so should the client.  You can probably safely catch and throw away this
exception in your code.
.IP "\fBRT::Client::REST::ImmutableFieldException\fR" 2
.IX Item "RT::Client::REST::ImmutableFieldException"
Trying to update an immutable field (such as \*(L"last_updated\*(R", for
example).
.IP "\fBRT::Client::REST::IllegalValueException\fR" 2
.IX Item "RT::Client::REST::IllegalValueException"
Illegal value for attribute was specified.
.RE
.RS 2
.RE
.IP "\fBRT::Client::REST::UnknownCustomFieldException\fR" 2
.IX Item "RT::Client::REST::UnknownCustomFieldException"
Unknown custom field was specified in the request.
.IP "\fBRT::Client::REST::InvalidQueryException\fR" 2
.IX Item "RT::Client::REST::InvalidQueryException"
Server could not parse the search query.
.IP "\fBRT::Client::REST::UnauthorizedActionException\fR" 2
.IX Item "RT::Client::REST::UnauthorizedActionException"
You are not authorized to perform this action.
.IP "\fBRT::Client::REST::AlreadyTicketOwnerException\fR" 2
.IX Item "RT::Client::REST::AlreadyTicketOwnerException"
The owner you are trying to assign to a ticket is already the owner.
This exception is usually thrown by methods \f(CW\*(C`take()\*(C'\fR, \f(CW\*(C`untake\*(C'\fR, and
\&\f(CW\*(C`steal\*(C'\fR, if the operation is a noop.
.IP "\fBRT::Client::REST::RequestTimedOutException\fR" 2
.IX Item "RT::Client::REST::RequestTimedOutException"
Request timed out.
.IP "\fBRT::Client::REST::UnknownRTException\fR" 2
.IX Item "RT::Client::REST::UnknownRTException"
Some other \s-1RT\s0 exception that the driver cannot recognize.
.RE
.RS 2
.RE
.RE
.RS 2
.RE
.SH "METHODS"
.IX Header "METHODS"
.IP "\fB_get_exception_class\fR" 2
.IX Item "_get_exception_class"
Figure out exception class based on content returned by \s-1RT.\s0
.IP "\fB_rt_content_to_exception\fR" 2
.IX Item "_rt_content_to_exception"
Translate error string returned by \s-1RT\s0 server into an exception object
ready to be thrown.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Exception::Class,
RT::Client::REST.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Abhijit Menon-Sen <ams@wiw.org>
.IP "\(bu" 4
Dmitri Tikhonov <dtikhonov@yahoo.com>
.IP "\(bu" 4
Damien \*(L"dams\*(R" Krotkine <dams@cpan.org>
.IP "\(bu" 4
Dean Hamstead <dean@bytefoundry.com.au>
.IP "\(bu" 4
Miquel Ruiz <mruiz@cpan.org>
.IP "\(bu" 4
\&\s-1JLMARTIN\s0
.IP "\(bu" 4
\&\s-1SRVSH\s0
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Dmitri Tikhonov.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.