User::Identity::Collection::Systems(3pm)

1User::Identity::CollectUisoenr::CSoynsttreimbsu(t3e)d PeUrslerD:o:cIudmeennttiattyi:o:nCollection::Systems(3)
2
3
4

NAME

6       User::Identity::Collection::Systems - a collection of system descrip‐
7       tions
8

INHERITANCE

10        User::Identity::Collection::Systems
11          is an User::Identity::Collection
12          is an User::Identity::Item
13

SYNOPSIS

DESCRIPTION

16       The User::Identity::Collection::Systems object maintains a set
17       User::Identity::System objects, each describing a login for the user on
18       some system.
19

OVERLOADED

21       overload: @{}
22
23           See "OVERLOADED" in User::Identity::Collection
24
25       overload: stringification
26
27           See "OVERLOADED" in User::Identity::Collection
28

METHODS

30       Constructors
31
32       User::Identity::Collection::Systems->new([NAME], OPTIONS)
33
34        Option     --Defined in     --Default
35        description  User::Identity::Item  undef
36        item_type    User::Identity::Collection  User::Identity::System
37        name         User::Identity::Item  'systems'
38        parent       User::Identity::Item  undef
39        roles        User::Identity::Collection  undef
40
41           . description STRING
42
43           . item_type CLASS
44
45           . name STRING
46
47           . parent OBJECT
48
49           . roles ROLE⎪ARRAY
50
51       Attributes
52
53       $obj->description
54
55           See "Attributes" in User::Identity::Item
56
57       $obj->itemType
58
59           See "Attributes" in User::Identity::Collection
60
61       $obj->name([NEWNAME])
62
63           See "Attributes" in User::Identity::Item
64
65       $obj->roles
66
67           See "Attributes" in User::Identity::Collection
68
69       Collections
70
71       $obj->add(COLLECTION, ROLE)
72
73           See "Collections" in User::Identity::Item
74
75       $obj->addCollection(OBJECT ⎪ ([TYPE], OPTIONS))
76
77           See "Collections" in User::Identity::Item
78
79       $obj->collection(NAME)
80
81           See "Collections" in User::Identity::Item
82
83       $obj->parent([PARENT])
84
85           See "Collections" in User::Identity::Item
86
87       $obj->removeCollection(OBJECT⎪NAME)
88
89           See "Collections" in User::Identity::Item
90
91       $obj->type
92
93       User::Identity::Collection::Systems->type
94
95           See "Collections" in User::Identity::Item
96
97       $obj->user
98
99           See "Collections" in User::Identity::Item
100
101       Maintaining roles
102
103       $obj->addRole(ROLE⎪ ( [NAME],OPTIONS ) ⎪ ARRAY-OF-OPTIONS)
104
105           See "Maintaining roles" in User::Identity::Collection
106
107       $obj->removeRole(ROLE⎪NAME)
108
109           See "Maintaining roles" in User::Identity::Collection
110
111       $obj->renameRole(ROLE⎪OLDNAME, NEWNAME)
112
113           See "Maintaining roles" in User::Identity::Collection
114
115       $obj->sorted
116
117           See "Maintaining roles" in User::Identity::Collection
118
119       Searching
120
121       $obj->find(NAME⎪CODE⎪undef)
122
123           See "Searching" in User::Identity::Collection
124

DIAGNOSTICS

126       Error: $object is not a collection.
127
128       The first argument is an object, but not of a class which extends
129       User::Identity::Collection.
130
131       Error: Cannot create a $type to add this to my collection.
132
133       Some options are specified to create a $type object, which is native to
134       this collection.  However, for some reason this failed.
135
136       Error: Cannot load collection module for $type ($class).
137
138       Either the specified $type does not exist, or that module named $class
139       returns compilation errors.  If the type as specified in the warning is
140       not the name of a package, you specified a nickname which was not
141       defined.  Maybe you forgot the 'require' the package which defines the
142       nickname.
143
144       Error: Cannot rename $name into $newname: already exists
145
146       Error: Cannot rename $name into $newname: doesn't exist
147
148       Error: Creation of a collection via $class failed.
149
150       The $class did compile, but it was not possible to create an object of
151       that class using the options you specified.
152
153       Error: Don't know what type of collection you want to add.
154
155       If you add a collection, it must either by a collection object or a
156       list of options which can be used to create a collection object.  In
157       the latter case, the type of collection must be specified.
158
159       Warning: No collection $name
160
161       The collection with $name does not exist and can not be created.
162
163       Error: Wrong type of role for $collection: requires a $expect but got a
164       $type
165
166       Each $collection groups sets of roles of one specific type ($expect).
167       You cannot add objects of a different $type.
168

LICENSE

174       Copyrights 2003,2004,2007 by Mark Overmeer <perl@overmeer.net>.For
175       other contributors see Changes.
176
177       This program is free software; you can redistribute it and/or modify it
178       under the same terms as Perl itself.  See
179       http://www.perl.com/perl/misc/Artistic.html
180
181
182
183perl v5.8.8                       2007-01U-s0e8r::Identity::Collection::Systems(3)