unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

User::Identity::CollecUser:ContributeUdsePre:r:Identity::Collection::Locations(3pm)



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

INHERITANCE
        User::Identity::Collection::Locations
          is an User::Identity::Collection
          is an User::Identity::Item

SYNOPSIS
DESCRIPTION
       The "User::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  User::Identity::Item  undef
        item_type    User::Identity::Collection  User::Identity::Location
        name         User::Identity::Item  'locations'
        parent       User::Identity::Item  undef
        roles        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: $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.

SEE ALSO
       This module is part of User-Identity distribution version 0.92, built
       on July 25, 2007. Website: http://perl.overmeer.net/userid/

LICENSE
       Copyrights 2003,2004,2007 by Mark Overmeer <perlATovermeer.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
       http://www.perl.com/perl/misc/Artistic.html



perl v5.8.8                       20User::Identity::Collection::Locations(3pm)