.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "User::Identity::Collection::Users 3pm"
.TH User::Identity::Collection::Users 3pm "2009-12-24" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
User::Identity::Collection::Users \- a collection of users
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\& User::Identity::Collection::Users
\&   is a User::Identity::Collection
\&   is a User::Identity::Item
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The User::Identity::Collection::Users object maintains a set
User::Identity objects, each describing a user.
.SH "OVERLOADED"
.IX Header "OVERLOADED"
overload: \fB@{}\fR
.Sp
.RS 4
See \*(L"\s-1OVERLOADED\s0\*(R" in User::Identity::Collection
.RE
.PP
overload: \fBstringification\fR
.Sp
.RS 4
See \*(L"\s-1OVERLOADED\s0\*(R" in User::Identity::Collection
.RE
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
User::Identity::Collection::Users\->\fBnew\fR([\s-1NAME\s0], \s-1OPTIONS\s0)
.Sp
.Vb 6
\& Option     \-\-Defined in     \-\-Default
\& description  User::Identity::Item  undef
\& item_type    User::Identity::Collection  User::Identity
\& name         User::Identity::Item  \*(Aqpeople\*(Aq
\& parent       User::Identity::Item  undef
\& roles        User::Identity::Collection  undef
.Ve
.Sp
.RS 4
\&. description => \s-1STRING\s0
.Sp
\&. item_type => \s-1CLASS\s0
.Sp
\&. name => \s-1STRING\s0
.Sp
\&. parent => \s-1OBJECT\s0
.Sp
\&. roles => ROLE|ARRAY
.RE
.SS "Attributes"
.IX Subsection "Attributes"
\&\f(CW$obj\fR\->\fBdescription\fR
.Sp
.RS 4
See \*(L"Attributes\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBitemType\fR
.Sp
.RS 4
See \*(L"Attributes\*(R" in User::Identity::Collection
.RE
.PP
\&\f(CW$obj\fR\->\fBname\fR([\s-1NEWNAME\s0])
.Sp
.RS 4
See \*(L"Attributes\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBroles\fR
.Sp
.RS 4
See \*(L"Attributes\*(R" in User::Identity::Collection
.RE
.SS "Collections"
.IX Subsection "Collections"
\&\f(CW$obj\fR\->\fBadd\fR(\s-1COLLECTION\s0, \s-1ROLE\s0)
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBaddCollection\fR(\s-1OBJECT\s0 | ([\s-1TYPE\s0], \s-1OPTIONS\s0))
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBcollection\fR(\s-1NAME\s0)
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBparent\fR([\s-1PARENT\s0])
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBremoveCollection\fR(OBJECT|NAME)
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBtype\fR
.PP
User::Identity::Collection::Users\->\fBtype\fR
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.PP
\&\f(CW$obj\fR\->\fBuser\fR
.Sp
.RS 4
See \*(L"Collections\*(R" in User::Identity::Item
.RE
.SS "Maintaining roles"
.IX Subsection "Maintaining roles"
\&\f(CW$obj\fR\->\fBaddRole\fR(ROLE| ( [\s-1NAME\s0],OPTIONS ) | ARRAY-OF-OPTIONS)
.Sp
.RS 4
See \*(L"Maintaining roles\*(R" in User::Identity::Collection
.RE
.PP
\&\f(CW$obj\fR\->\fBremoveRole\fR(ROLE|NAME)
.Sp
.RS 4
See \*(L"Maintaining roles\*(R" in User::Identity::Collection
.RE
.PP
\&\f(CW$obj\fR\->\fBrenameRole\fR(ROLE|OLDNAME, \s-1NEWNAME\s0)
.Sp
.RS 4
See \*(L"Maintaining roles\*(R" in User::Identity::Collection
.RE
.PP
\&\f(CW$obj\fR\->\fBsorted\fR
.Sp
.RS 4
See \*(L"Maintaining roles\*(R" in User::Identity::Collection
.RE
.SS "Searching"
.IX Subsection "Searching"
\&\f(CW$obj\fR\->\fBfind\fR(NAME|CODE|undef)
.Sp
.RS 4
See \*(L"Searching\*(R" in User::Identity::Collection
.RE
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Error: \f(CW$object\fR is not a collection.
.Sp
.RS 4
The first argument is an object, but not of a class which extends
User::Identity::Collection.
.RE
.PP
Error: Cannot create a \f(CW$type\fR to add this to my collection.
.Sp
.RS 4
Some options are specified to create a \f(CW$type\fR object, which is native to
this collection.  However, for some reason this failed.
.RE
.PP
Error: Cannot load collection module for \f(CW$type\fR ($class).
.Sp
.RS 4
Either the specified \f(CW$type\fR does not exist, or that module named \f(CW$class\fR 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.
.RE
.PP
Error: Cannot rename \f(CW$name\fR into \f(CW$newname:\fR already exists
.PP
Error: Cannot rename \f(CW$name\fR into \f(CW$newname:\fR doesn't exist
.PP
Error: Creation of a collection via \f(CW$class\fR failed.
.Sp
.RS 4
The \f(CW$class\fR did compile, but it was not possible to create an object
of that class using the options you specified.
.RE
.PP
Error: Don't know what type of collection you want to add.
.Sp
.RS 4
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.
.RE
.PP
Warning: No collection \f(CW$name\fR
.Sp
.RS 4
The collection with \f(CW$name\fR does not exist and can not be created.
.RE
.PP
Error: Wrong type of role for \f(CW$collection:\fR requires a \f(CW$expect\fR but got a \f(CW$type\fR
.Sp
.RS 4
Each \f(CW$collection\fR groups sets of roles of one specific type ($expect).  You
cannot add objects of a different \f(CW$type\fR.
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of User-Identity distribution version 0.93,
built on December 24, 2009. Website: \fIhttp://perl.overmeer.net/userid/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2003,2004,2007\-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR