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
7       descriptions
8

INHERITANCE

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

DIAGNOSTICS

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

LICENSE

169       Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>.
170       For other contributors see Changes.
171
172       This program is free software; you can redistribute it and/or modify it
173       under the same terms as Perl itself.  See
174       http://www.perl.com/perl/misc/Artistic.html
175
176
177
178perl v5.12.1                      2009-12U-s2e4r::Identity::Collection::Systems(3)