NAME
User::Identity::Collection::Locations - a collection of locations
INHERITANCE
User::Identity::Collection::Locations
is a User::Identity::Collection
is a User::Identity::ItemSYNOPSIS
DESCRIPTION
The User::Identity::Collection::Location object maintains a set User::Identity::Location objects, each describing a physical location.
OVERLOADED
overload: @{}
overload: stringification
METHODS
Constructors
User::Identity::Collection::Locations->new([NAME], OPTIONS)
Option Defined in Default
description L<User::Identity::Item> undef
item_type L<User::Identity::Collection> L<User::Identity::Location|User::Identity::Location>
name L<User::Identity::Item> C<'locations'>
parent L<User::Identity::Item> C<undef>
roles L<User::Identity::Collection> undef . description STRING
. item_type CLASS
. name STRING
. parent OBJECT
. roles ROLE|ARRAY
Attributes
$obj->description
$obj->itemType
$obj->name([NEWNAME])
$obj->roles
Collections
$obj->add(COLLECTION, ROLE)
$obj->addCollection(OBJECT | ([TYPE], OPTIONS))
$obj->collection(NAME)
$obj->parent([PARENT])
$obj->removeCollection(OBJECT|NAME)
$obj->type
User::Identity::Collection::Locations->type
$obj->user
Maintaining roles
$obj->addRole(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
$obj->removeRole(ROLE|NAME)
$obj->renameRole(ROLE|OLDNAME, NEWNAME)
$obj->sorted
Searching
$obj->find(NAME|CODE|undef)
DIAGNOSTICS
Error: $object is not a collection.
The first argument is an object, but not of a class which extends User::Identity::Collection.
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.
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.
Error: Cannot rename $name into $newname: already exists
Error: Cannot rename $name into $newname: doesn't exist
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.
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.
Warning: No collection $name
The collection with $name does not exist and can not be created.
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.
REFERENCES
See the User::Identity website at http://perl.overmeer.net/userid/ for more details.
COPYRIGHTS
User::Identity version 0.90. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.