• Bio::MAGE::AuditAndSecurity::Person
• SYNOPSIS
• DESCRIPTION
• INHERITANCE
• CLASS METHODS
• ATTRIBUTES
• ASSOCIATIONS
• BUGS
• AUTHOR
• SEE ALSO

Bio::MAGE::AuditAndSecurity::Person

SYNOPSIS

  use Bio::MAGE::AuditAndSecurity::Person;

    # creating an empty instance
  my $person = Bio::MAGE::AuditAndSecurity::Person->new();

    # creating an already populated instance
  my $person = Bio::MAGE::AuditAndSecurity::Person->new(firstName=>$firstName_value,
                        midInitials=>$midInitials_value,
                        lastName=>$lastName_value,
                        affiliation=>$affiliation_value);

    # setting and retrieving object attributes
  my $firstName_val = $person->firstName();
  $person->firstName($value);

  my $midInitials_val = $person->midInitials();
  $person->midInitials($value);

  my $lastName_val = $person->lastName();
  $person->lastName($value);

    # setting and retrieving object associations
  my $affiliation_val = $person->affiliation();
  $person->affiliation($value);

DESCRIPTION

From the MAGE-OM documentation for the Person class:

A person for which the attributes are self describing.

INHERITANCE

Bio::MAGE::AuditAndSecurity::Person has the following super classes

• Bio::MAGE::AuditAndSecurity::Contact
  

CLASS METHODS

The following methods can all be called without first having an instance of the class via the Bio::MAGE::AuditAndSecurity::Person->methodname() syntax.

new()

new(%args)

The object constructor new() accepts the following optional named-value style arguments:

• firstName
  Sets the value of the firstName attribute (from Bio::MAGE::AuditAndSecurity::Person).

• midInitials
  Sets the value of the midInitials attribute (from Bio::MAGE::AuditAndSecurity::Person).

• lastName
  Sets the value of the lastName attribute (from Bio::MAGE::AuditAndSecurity::Person).

• affiliation
  Sets the value of the affiliation association (from Bio::MAGE::AuditAndSecurity::Person).

• URI
  Sets the value of the URI attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• address
  Sets the value of the address attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• phone
  Sets the value of the phone attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• tollFreePhone
  Sets the value of the tollFreePhone attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• email
  Sets the value of the email attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• fax
  Sets the value of the fax attribute (from Bio::MAGE::AuditAndSecurity::Contact).

• roles
  Sets the value of the roles association (from Bio::MAGE::AuditAndSecurity::Contact).

• identifier
  Sets the value of the identifier attribute (from Bio::MAGE::Identifiable).

• name
  Sets the value of the name attribute (from Bio::MAGE::Identifiable).

• security
  Sets the value of the security association (from Bio::MAGE::Describable).

• auditTrail
  Sets the value of the auditTrail association (from Bio::MAGE::Describable).

• descriptions
  Sets the value of the descriptions association (from Bio::MAGE::Describable).

• propertySets
  Sets the value of the propertySets association (from Bio::MAGE::Extendable).

$obj->set_slots(%parameters)

$obj->set_slots(\@name_list, \@value_list)

The set_slots() method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references.

Return value: none

Side effects: will call croak() if a slot_name is used that the class does not define.

$obj->get_slots(@name_list)

The get_slots() method is used to get the values of a number of slots at the same time.

Return value: a list of instance objects

Side effects: none

$val = $obj->set_slot($name,$val)

The set_slot() method sets the slot $name to the value $val

Return value: the new value of the slot, i.e. $val

Side effects: none

$val = $obj->get_slot($name)

The get_slot() method is used to get the values of a number of slots at the same time.

Return value: a single slot value, or undef if the slot has not been initialized.

Side effects: none

@names = $obj->get_slot_names()

The get_slot_names() method is used to retrieve the name of all slots defined for a given object.

Return value: a single slot value, or undef if the slot has not been initialized.

Side effects: none

$name = class_name()

Returns the full class name for this class, Bio::MAGE::AuditAndSecurity::Person.

$package_name = package()

Returns the unresolved package name (i.e. no 'Bio::MAGE::') of the package that contains class, Bio::MAGE::AuditAndSecurity::Person.

@classes = subclasses()

returns the list of subclasses for this class.

@classes = superclasses()

returns the list of superclasses for this class.

@methods = attribute_methods()

returns the list of attribute accessor methods for this class.

@methods = association_methods()

returns the list of association accessor methods for this class.

%assns = associations()

returns the association meta-information in a hash where the keys are the association names and the values are Bio::MAGE::Association objects that provide the meta-information for the association.

ATTRIBUTES

Attributes are simple data types that belong to a single instance of a class. In the Perl implementation of the MAGE-OM classes, the interface to attributes is implemented using separate setter and getter methods for each attribute.

Bio::MAGE::AuditAndSecurity::Person: has the following attribute accessor methods:

firstName

Methods for the firstName attribute.

$val = $person->setFirstName($val)

The restricted setter method for the firstName attribute.

Input parameters: the value to which the firstName attribute will be set

Return value: the current value of the firstName attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $person->getFirstName()

The restricted getter method for the firstName attribute.

Input parameters: none

Return value: the current value of the firstName attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

midInitials

Methods for the midInitials attribute.

$val = $person->setMidInitials($val)

The restricted setter method for the midInitials attribute.

Input parameters: the value to which the midInitials attribute will be set

Return value: the current value of the midInitials attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $person->getMidInitials()

The restricted getter method for the midInitials attribute.

Input parameters: none

Return value: the current value of the midInitials attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

lastName

Methods for the lastName attribute.

$val = $person->setLastName($val)

The restricted setter method for the lastName attribute.

Input parameters: the value to which the lastName attribute will be set

Return value: the current value of the lastName attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $person->getLastName()

The restricted getter method for the lastName attribute.

Input parameters: none

Return value: the current value of the lastName attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

Attributes Inherited from Bio::MAGE::AuditAndSecurity::Contact

URI

Methods for the URI attribute.

$val = $contact->setURI($val)

The restricted setter method for the URI attribute.

Input parameters: the value to which the URI attribute will be set

Return value: the current value of the URI attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getURI()

The restricted getter method for the URI attribute.

Input parameters: none

Return value: the current value of the URI attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

address

Methods for the address attribute.

$val = $contact->setAddress($val)

The restricted setter method for the address attribute.

Input parameters: the value to which the address attribute will be set

Return value: the current value of the address attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getAddress()

The restricted getter method for the address attribute.

Input parameters: none

Return value: the current value of the address attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

phone

Methods for the phone attribute.

$val = $contact->setPhone($val)

The restricted setter method for the phone attribute.

Input parameters: the value to which the phone attribute will be set

Return value: the current value of the phone attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getPhone()

The restricted getter method for the phone attribute.

Input parameters: none

Return value: the current value of the phone attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

tollFreePhone

Methods for the tollFreePhone attribute.

$val = $contact->setTollFreePhone($val)

The restricted setter method for the tollFreePhone attribute.

Input parameters: the value to which the tollFreePhone attribute will be set

Return value: the current value of the tollFreePhone attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getTollFreePhone()

The restricted getter method for the tollFreePhone attribute.

Input parameters: none

Return value: the current value of the tollFreePhone attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

email

Methods for the email attribute.

$val = $contact->setEmail($val)

The restricted setter method for the email attribute.

Input parameters: the value to which the email attribute will be set

Return value: the current value of the email attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getEmail()

The restricted getter method for the email attribute.

Input parameters: none

Return value: the current value of the email attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

fax

Methods for the fax attribute.

$val = $contact->setFax($val)

The restricted setter method for the fax attribute.

Input parameters: the value to which the fax attribute will be set

Return value: the current value of the fax attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $contact->getFax()

The restricted getter method for the fax attribute.

Input parameters: none

Return value: the current value of the fax attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

Attributes Inherited from Bio::MAGE::Identifiable

identifier

From the MAGE-OM documentation for the identifier attribute:

An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.

$val = $identifiable->setIdentifier($val)

The restricted setter method for the identifier attribute.

Input parameters: the value to which the identifier attribute will be set

Return value: the current value of the identifier attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $identifiable->getIdentifier()

The restricted getter method for the identifier attribute.

Input parameters: none

Return value: the current value of the identifier attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

name

From the MAGE-OM documentation for the name attribute:

The potentially ambiguous common identifier.

$val = $identifiable->setName($val)

The restricted setter method for the name attribute.

Input parameters: the value to which the name attribute will be set

Return value: the current value of the name attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

$val = $identifiable->getName()

The restricted getter method for the name attribute.

Input parameters: none

Return value: the current value of the name attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

ASSOCIATIONS

Associations are references to other class objects which can be shared by multiple class instances at the same time. In the Perl implementation of MAGE-OM classes, associations are implemented using three separate methods:

get*

Retrieves the current value. If the association has list cardinality, an array reference is returned.

set*

Sets the current value replacing any existing value. If the association has list cardinality, the argument must be an array reference. Unless you know what you are doing, you probably should be using the add* methods.

add*

This method exists only for associations with list cardinality. It appends a list of objects to any values that may already be stored in the association.

Bio::MAGE::AuditAndSecurity::Person: has the following association accessor methods:

affiliation

From the MAGE-OM documentation for the affiliation association:

The organization a person belongs to.

$val = $person->setAffiliation($val)

The restricted setter method for the affiliation association.

Input parameters: the value to which the affiliation association will be set : an instance of type Bio::MAGE::AuditAndSecurity::Organization.

Return value: the current value of the affiliation association : an instance of type Bio::MAGE::AuditAndSecurity::Organization.

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $val is not an instance of class Bio::MAGE::AuditAndSecurity::Organization

$val = $person->getAffiliation()

The restricted getter method for the affiliation association.

Input parameters: none

Return value: the current value of the affiliation association : an instance of type Bio::MAGE::AuditAndSecurity::Organization.

Side effects: none

Exceptions: will call croak() if any input parameters are specified

Associations Inherited from Bio::MAGE::AuditAndSecurity::Contact

roles

From the MAGE-OM documentation for the roles association:

The roles (lab equipment sales, contractor, etc.) the contact fills.

$array_ref = $contact->setRoles($array_ref)

The restricted setter method for the roles association.

Input parameters: the value to which the roles association will be set : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry

Return value: the current value of the roles association : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $array_ref is not a reference to an array class Bio::MAGE::Description::OntologyEntry instances

$array_ref = $contact->getRoles()

The restricted getter method for the roles association.

Input parameters: none

Return value: the current value of the roles association : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$contact->addRoles(@vals)

Because the roles association has list cardinality, it may store more than one value. This method adds the current list of objects in the roles association.

Input parameters: the list of values @vals to add to the roles association. NOTE: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call croak() if no input parameters are specified , or if any of the objects in @vals is not an instance of class Bio::MAGE::Description::OntologyEntry

Associations Inherited from Bio::MAGE::Describable

security

From the MAGE-OM documentation for the security association:

Information on the security for the instance of the class.

$val = $describable->setSecurity($val)

The restricted setter method for the security association.

Input parameters: the value to which the security association will be set : an instance of type Bio::MAGE::AuditAndSecurity::Security.

Return value: the current value of the security association : an instance of type Bio::MAGE::AuditAndSecurity::Security.

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $val is not an instance of class Bio::MAGE::AuditAndSecurity::Security

$val = $describable->getSecurity()

The restricted getter method for the security association.

Input parameters: none

Return value: the current value of the security association : an instance of type Bio::MAGE::AuditAndSecurity::Security.

Side effects: none

Exceptions: will call croak() if any input parameters are specified

auditTrail

From the MAGE-OM documentation for the auditTrail association:

A list of Audit instances that track changes to the instance of Describable.

$array_ref = $describable->setAuditTrail($array_ref)

The restricted setter method for the auditTrail association.

Input parameters: the value to which the auditTrail association will be set : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit

Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $array_ref is not a reference to an array class Bio::MAGE::AuditAndSecurity::Audit instances

$array_ref = $describable->getAuditTrail()

The restricted getter method for the auditTrail association.

Input parameters: none

Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$describable->addAuditTrail(@vals)

Because the auditTrail association has list cardinality, it may store more than one value. This method adds the current list of objects in the auditTrail association.

Input parameters: the list of values @vals to add to the auditTrail association. NOTE: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call croak() if no input parameters are specified , or if any of the objects in @vals is not an instance of class Bio::MAGE::AuditAndSecurity::Audit

descriptions

From the MAGE-OM documentation for the descriptions association:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.

$array_ref = $describable->setDescriptions($array_ref)

The restricted setter method for the descriptions association.

Input parameters: the value to which the descriptions association will be set : a reference to an array of objects of type Bio::MAGE::Description::Description

Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $array_ref is not a reference to an array class Bio::MAGE::Description::Description instances

$array_ref = $describable->getDescriptions()

The restricted getter method for the descriptions association.

Input parameters: none

Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$describable->addDescriptions(@vals)

Because the descriptions association has list cardinality, it may store more than one value. This method adds the current list of objects in the descriptions association.

Input parameters: the list of values @vals to add to the descriptions association. NOTE: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call croak() if no input parameters are specified , or if any of the objects in @vals is not an instance of class Bio::MAGE::Description::Description

Associations Inherited from Bio::MAGE::Extendable

propertySets

From the MAGE-OM documentation for the propertySets association:

Allows specification of name/value pairs. Meant to primarily help in-house, pipeline processing of instances by providing a place for values that aren't part of the specification proper.

$array_ref = $extendable->setPropertySets($array_ref)

The restricted setter method for the propertySets association.

Input parameters: the value to which the propertySets association will be set : a reference to an array of objects of type Bio::MAGE::NameValueType

Return value: the current value of the propertySets association : a reference to an array of objects of type Bio::MAGE::NameValueType

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified , or if $array_ref is not a reference to an array class Bio::MAGE::NameValueType instances

$array_ref = $extendable->getPropertySets()

The restricted getter method for the propertySets association.

Input parameters: none

Return value: the current value of the propertySets association : a reference to an array of objects of type Bio::MAGE::NameValueType

Side effects: none

Exceptions: will call croak() if any input parameters are specified

$extendable->addPropertySets(@vals)

Because the propertySets association has list cardinality, it may store more than one value. This method adds the current list of objects in the propertySets association.

Input parameters: the list of values @vals to add to the propertySets association. NOTE: submitting a single value is permitted.

Return value: none

Side effects: none

Exceptions: will call croak() if no input parameters are specified , or if any of the objects in @vals is not an instance of class Bio::MAGE::NameValueType

BUGS

Please send bug reports to mged-mage@lists.sf.net

AUTHOR

Jason E. Stewart (www.openinformatics.com)

SEE ALSO

perl(1).