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
|
# RT::Client::REST::Group -- group object representation.
package RT::Client::REST::Group;
use strict;
use warnings;
use vars qw($VERSION);
$VERSION = 0.03;
use Params::Validate qw(:types);
use RT::Client::REST 0.14;
use RT::Client::REST::Object 0.01;
use RT::Client::REST::Object::Exception 0.01;
use RT::Client::REST::SearchResult 0.02;
use base 'RT::Client::REST::Object';
=head1 NAME
RT::Client::REST::Group -- group object representation.
=head1 SYNOPSIS
my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
my $group = RT::Client::REST::Group->new(
rt => $rt,
id => $id,
)->retrieve;
=head1 DESCRIPTION
B<RT::Client::REST::Group> is based on L<RT::Client::REST::Object>.
The representation allows one to retrieve, edit, and create groups in RT.
Note: RT currently does not allow REST client to search groups.
=cut
sub _attributes {{
id => {
validation => {
type => SCALAR,
},
form2value => sub {
shift =~ m~^group/(\d+)$~i;
return $1;
},
value2form => sub {
return 'group/' . shift;
},
},
name => {
validation => {
type => SCALAR,
},
},
description => {
validation => {
type => SCALAR,
},
},
members => {
validation => {
type => ARRAYREF,
},
list => 1,
},
disabled => {
validation => {
type => SCALAR,
},
},
}}
=head1 ATTRIBUTES
=over 2
=item B<id>
For retrieval, you can specify either the numeric ID of the group or his
group name. After the retrieval, however, this attribute will be set
to the numeric id.
=item B<name>
Name of the group
=item B<description>
Description
=item B<members>
List of the members of this group.
=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 RT group from database.
=item B<store>
Create or update the group.
=item B<search>
Currently RT does not allow REST clients to search groups.
=back
=head1 INTERNAL METHODS
=over 2
=item B<rt_type>
Returns 'group'.
=cut
sub rt_type { 'group' }
=back
=head1 SEE ALSO
L<RT::Client::REST>, L<RT::Client::REST::Object>,
L<RT::Client::REST::SearchResult>.
=head1 AUTHOR
Miquel Ruiz <mruiz@cpan.org>
=head1 LICENSE
Perl license.
=cut
__PACKAGE__->_generate_methods;
1;
|
