1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# RT::Client::REST::Queue -- queue object representation.
package RT::Client::REST::Queue;
use strict;
use warnings;
use vars qw($VERSION);
$VERSION = '0.02';
use Params::Validate qw(:types);
use RT::Client::REST 0.20;
use RT::Client::REST::Object 0.01;
use RT::Client::REST::Object::Exception 0.01;
use RT::Client::REST::SearchResult 0.02;
use RT::Client::REST::Ticket;
use base 'RT::Client::REST::Object';
=head1 NAME
RT::Client::REST::Queue -- queue object representation.
=head1 SYNOPSIS
my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
my $queue = RT::Client::REST::Queue->new(
rt => $rt,
id => 'General',
)->retrieve;
=head1 DESCRIPTION
B<RT::Client::REST::Queue> is based on L<RT::Client::REST::Object>.
The representation allows one to retrieve, edit, comment on, and create
queue in RT.
Note: RT currently does not allow REST client to search queues.
=cut
sub _attributes {{
id => {
validation => {
type => SCALAR,
},
form2value => sub {
shift =~ m~^queue/(\d+)$~i;
return $1;
},
value2form => sub {
return 'queue/' . shift;
},
},
name => {
validation => {
type => SCALAR,
},
},
description => {
validation => {
type => SCALAR,
},
},
correspond_address => {
validation => {
type => SCALAR,
},
rest_name => 'CorrespondAddress',
},
comment_address => {
validation => {
type => SCALAR,
},
rest_name => 'CommentAddress',
},
initial_priority => {
validation => {
type => SCALAR,
},
rest_name => 'InitialPriority',
},
final_priority => {
validation => {
type => SCALAR,
},
rest_name => 'FinalPriority',
},
default_due_in => {
validation => {
type => SCALAR,
},
rest_name => 'DefaultDueIn',
},
disabled => {
validation => {
type => SCALAR,
},
},
}}
=head1 ATTRIBUTES
=over 2
=item B<id>
For retrieval, you can specify either the numeric ID of the queue or its
name (case-sensitive). After the retrieval, however, this attribute will
be set to the numeric id.
=item B<name>
This is the name of the queue.
=item B<description>
Queue description.
=item B<correspond_address>
Correspond address.
=item B<comment_address>
Comment address.
=item B<initial_priority>
Initial priority.
=item B<final_priority>
Final priority.
=item B<default_due_in>
Default due in.
=back
=head1 DB METHODS
For full explanation of these, please see B<"DB METHODS"> in
L<RT::Client::REST::Object> documentation.
=over 2
=item B<retrieve>
Retrieve queue from database.
=item B<store>
Create or update the queue.
=item B<search>
Currently RT does not allow REST clients to search queues.
=back
=head1 QUEUE-SPECIFIC METHODS
=over 2
=item B<tickets>
Get tickets that are in this queue (note: this may be a lot of tickets).
Note: tickets with status "deleted" will not be shown.
Object of type L<RT::Client::REST::SearchResult> is returned which then
can be used to get to objects of type L<RT::Client::REST::Ticket>.
=cut
sub tickets {
my $self = shift;
$self->_assert_rt_and_id;
return RT::Client::REST::Ticket
->new(rt => $self->rt)
->search(limits => [
{attribute => 'queue', operator => '=', value => $self->id},
]);
}
=back
=head1 INTERNAL METHODS
=over 2
=item B<rt_type>
Returns 'queue'.
=cut
sub rt_type { 'queue' }
=back
=head1 SEE ALSO
L<RT::Client::REST>, L<RT::Client::REST::Object>,
L<RT::Client::REST::SearchResult>,
L<RT::Client::REST::Ticket>.
=head1 AUTHOR
Dmitri Tikhonov <dtikhonov@yahoo.com>
=head1 LICENSE
Perl license.
=cut
__PACKAGE__->_generate_methods;
1;
|
