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
20       Extends "DESCRIPTION" in User::Identity::Collection.
21

OVERLOADED

23       Extends "OVERLOADED" in User::Identity::Collection.
24
25       overload: @{}
26           Inherited, see "OVERLOADED" in User::Identity::Collection
27
28       overload: stringification
29           Inherited, see "OVERLOADED" in User::Identity::Collection
30

METHODS

32       Extends "METHODS" in User::Identity::Collection.
33
34   Constructors
35       Extends "Constructors" in User::Identity::Collection.
36
37       User::Identity::Collection::Systems->new( [$name], %options )
38            -Option     --Defined in                --Default
39             description  User::Identity::Item        undef
40             item_type    User::Identity::Collection  User::Identity::System
41             name         User::Identity::Item        'systems'
42             parent       User::Identity::Item        undef
43             roles        User::Identity::Collection  undef
44
45           description => STRING
46           item_type => CLASS
47           name => STRING
48           parent => OBJECT
49           roles => ROLE|ARRAY
50
51   Attributes
52       Extends "Attributes" in User::Identity::Collection.
53
54       $obj->description()
55           Inherited, see "Attributes" in User::Identity::Item
56
57       $obj->itemType()
58           Inherited, see "Attributes" in User::Identity::Collection
59
60       $obj->name( [$newname] )
61           Inherited, see "Attributes" in User::Identity::Item
62
63       $obj->roles()
64           Inherited, see "Attributes" in User::Identity::Collection
65
66   Collections
67       Extends "Collections" in User::Identity::Collection.
68
69       $obj->add($collection, $role)
70           Inherited, see "Collections" in User::Identity::Item
71
72       $obj->addCollection( $object | <[$type], %options> )
73           Inherited, see "Collections" in User::Identity::Item
74
75       $obj->collection($name)
76           Inherited, see "Collections" in User::Identity::Item
77
78       $obj->parent( [$parent] )
79           Inherited, see "Collections" in User::Identity::Item
80
81       $obj->removeCollection($object|$name)
82           Inherited, see "Collections" in User::Identity::Item
83
84       $obj->type()
85       User::Identity::Collection::Systems->type()
86           Inherited, see "Collections" in User::Identity::Item
87
88       $obj->user()
89           Inherited, see "Collections" in User::Identity::Item
90
91   Maintaining roles
92       Extends "Maintaining roles" in User::Identity::Collection.
93
94       $obj->addRole($role| <[$name],%options> | ARRAY)
95           Inherited, see "Maintaining roles" in User::Identity::Collection
96
97       $obj->removeRole($role|$name)
98           Inherited, see "Maintaining roles" in User::Identity::Collection
99
100       $obj->renameRole( <$role|$oldname>, $newname )
101           Inherited, see "Maintaining roles" in User::Identity::Collection
102
103       $obj->sorted()
104           Inherited, see "Maintaining roles" in User::Identity::Collection
105
106   Searching
107       Extends "Searching" in User::Identity::Collection.
108
109       $obj->find($name|CODE|undef)
110           Inherited, see "Searching" in User::Identity::Collection
111

DIAGNOSTICS

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

LICENSE

152       Copyrights 2003-2023 by [Mark Overmeer <markov@cpan.org>]. For other
153       contributors see ChangeLog.
154
155       This program is free software; you can redistribute it and/or modify it
156       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
157
158
159
160perl v5.36.1                      2023-04U-s3e0r::Identity::Collection::Systems(3)