=encoding utf8
=head1 NAME
User::Identity::Collection::Systems - a collection of system descriptions
=head1 INHERITANCE
User::Identity::Collection::Systems
is a User::Identity::Collection
is a User::Identity::Item
=head1 SYNOPSIS
=head1 DESCRIPTION
The L<User::Identity::Collection::Systems|User::Identity::Collection::Systems> object maintains a set
L<User::Identity::System|User::Identity::System> objects, each describing a login for the
user on some system.
Extends L<"DESCRIPTION" in User::Identity::Collection|User::Identity::Collection/"DESCRIPTION">.
=head1 OVERLOADED
Extends L<"OVERLOADED" in User::Identity::Collection|User::Identity::Collection/"OVERLOADED">.
=over 4
=item overload: B<@{}>
Inherited, see L<User::Identity::Collection/"OVERLOADED">
=item overload: B<stringification>
Inherited, see L<User::Identity::Collection/"OVERLOADED">
=back
=head1 METHODS
Extends L<"METHODS" in User::Identity::Collection|User::Identity::Collection/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in User::Identity::Collection|User::Identity::Collection/"Constructors">.
=over 4
=item User::Identity::Collection::Systems-E<gt>B<new>( [NAME], OPTIONS )
-Option --Defined in --Default
description User::Identity::Item undef
item_type User::Identity::Collection User::Identity::System
name User::Identity::Item 'systems'
parent User::Identity::Item undef
roles User::Identity::Collection undef
=over 2
=item description => STRING
=item item_type => CLASS
=item name => STRING
=item parent => OBJECT
=item roles => ROLE|ARRAY
=back
=back
=head2 Attributes
Extends L<"Attributes" in User::Identity::Collection|User::Identity::Collection/"Attributes">.
=over 4
=item $obj-E<gt>B<description>()
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<itemType>()
Inherited, see L<User::Identity::Collection/"Attributes">
=item $obj-E<gt>B<name>( [NEWNAME] )
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<roles>()
Inherited, see L<User::Identity::Collection/"Attributes">
=back
=head2 Collections
Extends L<"Collections" in User::Identity::Collection|User::Identity::Collection/"Collections">.
=over 4
=item $obj-E<gt>B<add>(COLLECTION, ROLE)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>(NAME)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<parent>( [PARENT] )
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>(OBJECT|NAME)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item User::Identity::Collection::Systems-E<gt>B<type>()
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
Inherited, see L<User::Identity::Item/"Collections">
=back
=head2 Maintaining roles
Extends L<"Maintaining roles" in User::Identity::Collection|User::Identity::Collection/"Maintaining roles">.
=over 4
=item $obj-E<gt>B<addRole>(ROLE| ([NAME],OPTIONS) | ARRAY)
Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<removeRole>(ROLE|NAME)
Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<renameRole>( <ROLE|OLDNAME>, NEWNAME )
Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<sorted>()
Inherited, see L<User::Identity::Collection/"Maintaining roles">
=back
=head2 Searching
Extends L<"Searching" in User::Identity::Collection|User::Identity::Collection/"Searching">.
=over 4
=item $obj-E<gt>B<find>(NAME|CODE|undef)
Inherited, see L<User::Identity::Collection/"Searching">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: $object is not a collection.
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
=item Error: Cannot create a $type to add this to my collection.
Some options are specified to create a $type object, which is native to
this collection. However, for some reason this failed.
=item Error: Cannot load collection module for $type ($class).
Either the specified $type does not exist, or that module named $class returns
compilation errors. If the type as specified in the warning is not
the name of a package, you specified a nickname which was not defined.
Maybe you forgot the 'require' the package which defines the nickname.
=item Error: Cannot rename $name into $newname: already exists
=item Error: Cannot rename $name into $newname: doesn't exist
=item Error: Creation of a collection via $class failed.
The $class did compile, but it was not possible to create an object
of that class using the options you specified.
=item Error: Don't know what type of collection you want to add.
If you add a collection, it must either by a collection object or a
list of options which can be used to create a collection object. In
the latter case, the type of collection must be specified.
=item Warning: No collection $name
The collection with $name does not exist and can not be created.
=item Error: Wrong type of role for $collection: requires a $expect but got a $type
Each $collection groups sets of roles of one specific type ($expect). You
cannot add objects of a different $type.
=back
=head1 SEE ALSO
This module is part of User-Identity distribution version 0.96,
built on September 19, 2016. Website: F<http://perl.overmeer.net/userid/>
=head1 LICENSE
Copyrights 2003-2016 by [Mark Overmeer <perl@overmeer.net>]. For other contributors see Changes.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>