/ 
PerlBean-0.2.0.2
River stage zero No dependents
/ PerlBean::Attribute::Multi::Unique::Ordered

NAME

PerlBean::Attribute::Multi::Unique::Ordered - contains unique ordered MULTI bean attribute information

SYNOPSIS

use strict;
use PerlBean::Attribute::Multi::Unique::Ordered;
my $attr = PerlBean::Attribute::Multi::Unique::Ordered->new ({
	attribute_name => 'locations_in_traveling_salesman_itinerary',
	short_description => 'the locations in a traveling salesman\'s itinerary',
});

use IO::File;
-d 'tmp' || mkdir ('tmp');
my $fh = IO::File->new ('> tmp/PerlBean_Attribute_Multi_Unique_Ordered.pl.out');
$attr->writeMethods ($fh);
$attr->writeDocMethods ($fh);

ABSTRACT

Unique, ordered MULTI bean attribute information

DESCRIPTION

PerlBean::Attribute::Multi::Unique::Ordered contains unique ordered MULTI bean attribute information. It is a subclass of PerlBean::Attribute::Multi. The code generation and documentation methods from PerlBean::Attribute are implemented.`

CONSTRUCTOR

new (OPT_HASH_REF)

Creates a new PerlBean::Attribute::Multi::Unique::Ordered object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF inherited through package PerlBean::Attribute may include:

attribute_name

Passed to "setAttributeName ()". Mandatory option.

default_value

Passed to "setDefaultValue ()".

exception_class

Passed to "setExceptionClass ()". Defaults to Error::Simple.

mandatory

Passed to "setMandatory ()". Defaults to 0.

method_base

Passed to "setMethodBase ()".

perl_bean

Passed to "setPerlBean ()".

short_description

Passed to "setShortDescription ()".

Options for OPT_HASH_REF inherited through package PerlBean::Attribute::Single may include:

allow_empty

Passed to "setAllowEmpty ()". Defaults to 1.

allow_isa

Passed to "setAllowIsa ()". Must be an ARRAY reference.

allow_ref

Passed to "setAllowRef ()". Must be an ARRAY reference.

allow_rx

Passed to "setAllowRx ()". Must be an ARRAY reference.

allow_value

Passed to "setAllowValue ()". Must be an ARRAY reference.

METHODS

Inherited/implemented from PerlBean::Attribute.

writeMethods (FILEHANDLE)

Writes code for set, push, pop, shift, unshift, exists and get methods.

writeDocMethods (FILEHANDLE)

Writes documenation for set, push, pop, shift, unshift, exists an d get methods.

INHERITED METHODS FROM PerlBean::Attribute

To access attribute named attribute_name:

setAttributeName (), getAttributeName ()

To access attribute named default_value:

setDefaultValue (), getDefaultValue ()

To access attribute named exception_class:

setExceptionClass (), getExceptionClass ()

To access attribute named mandatory:

setMandatory (), isMandatory ()

To access attribute named method_base:

setMethodBase (), getMethodBase ()

To access attribute named perl_bean:

setPerlBean (), getPerlBean ()

To access attribute named short_description:

setShortDescription (), getShortDescription ()

INHERITED METHODS FROM PerlBean::Attribute::Single

To access attribute named allow_empty:

setAllowEmpty (), isAllowEmpty ()

To access attribute named allow_isa:

setAllowIsa (), addAllowIsa (), deleteAllowIsa (), existsAllowIsa (), valuesAllowIsa ()

To access attribute named allow_ref:

setAllowRef (), addAllowRef (), deleteAllowRef (), existsAllowRef (), valuesAllowRef ()

To access attribute named allow_rx:

setAllowRx (), addAllowRx (), deleteAllowRx (), existsAllowRx (), valuesAllowRx ()

To access attribute named allow_value:

setAllowValue (), addAllowValue (), deleteAllowValue (), existsAllowValue (), valuesAllowValue ()

SEE ALSO

PerlBean, PerlBean::Attribute, PerlBean::Attribute::Boolean, PerlBean::Attribute::Factory, PerlBean::Attribute::Multi, PerlBean::Attribute::Multi::Ordered, PerlBean::Attribute::Multi::Unique, PerlBean::Attribute::Multi::Unique::Associative, PerlBean::Attribute::Single, PerlBean::Collection

BUGS

None known (yet.)

HISTORY

First development: November 2002

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2002 by Vincenzo Zocca

LICENSE

This file is part of the PerlBean module hierarchy for Perl by Vincenzo Zocca.

The PerlBean module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The PerlBean module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the PerlBean module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA