man User::Identity::Collection::Locations () - a collection of locations

NAME

User::Identity::Collection::Locations - a collection of locations

INHERITANCE

 User::Identity::Collection::Locations
   is a User::Identity::Collection
   is a User::Identity::Item

SYNOPSIS

DESCRIPTION

The CWUser::Identity::Collection::Location object maintains a set User::Identity::Location objects, each describing a physical location.

OVERLOADED

overload: @{} See OVERLOADED in User::Identity::Collection

overload: stringification See OVERLOADED in User::Identity::Collection

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 See Attributes in User::Identity::Item

$obj->itemType See Attributes in User::Identity::Collection

$obj->name([NEWNAME]) See Attributes in User::Identity::Item

$obj->roles See Attributes in User::Identity::Collection

Collections

$obj->add(COLLECTION, ROLE) See Collections in User::Identity::Item

$obj->addCollection(OBJECT | ([TYPE], OPTIONS)) See Collections in User::Identity::Item

$obj->collection(NAME) See Collections in User::Identity::Item

$obj->parent([PARENT]) See Collections in User::Identity::Item

$obj->removeCollection(OBJECT|NAME) See Collections in User::Identity::Item

$obj->type

User::Identity::Collection::Locations->type See Collections in User::Identity::Item

$obj->user See Collections in User::Identity::Item

Maintaining roles

$obj->addRole(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS) See Maintaining roles in User::Identity::Collection

$obj->removeRole(ROLE|NAME) See Maintaining roles in User::Identity::Collection

$obj->renameRole(ROLE|OLDNAME, NEWNAME) See Maintaining roles in User::Identity::Collection

$obj->sorted See Maintaining roles in User::Identity::Collection

Searching

$obj->find(NAME|CODE|undef) See Searching in User::Identity::Collection

DIAGNOSTICS

Error: CW$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 CW$type to add this to my collection.

Some options are specified to create a CW$type object, which is native to this collection. However, for some reason this failed.

Error: Cannot load collection module for CW$type ($class).

Either the specified CW$type does not exist, or that module named CW$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 CW$name into CW$newname: already exists

Error: Cannot rename CW$name into CW$newname: doesn't exist

Error: Creation of a collection via CW$class failed.

The CW$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 CW$name

The collection with CW$name does not exist and can not be created.

Error: Wrong type of role for CW$collection: requires a CW$expect but got a CW$type

Each CW$collection groups sets of roles of one specific type ($expect). You cannot add objects of a different CW$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.