MAGE::...Contact(3pm)

📦 version 20030502.3, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

Bio::MAGE::AuditAndSecurity::Contact — bestie, this is the class for the MAGE-OM API 💖 (it lives in the MAGE::...Contact(3pm) part of your friendly local User Contributed Perl Documentation, if you were wondering where you wandered in from).

🎀 SYNOPSIS 🎀

use Bio::MAGE::AuditAndSecurity::Contact

# Bio::MAGE::AuditAndSecurity::Contact is an abstract base class and should not
# be directly instantiated. These examples indicate how subclass
# objects will behave

# 'URI' attribute
my $URI_val = $contact->URI(); # getter
$contact->URI($value); # setter

# 'name' attribute
my $name_val = $contact->name(); # getter
$contact->name($value); # setter

# 'phone' attribute
my $phone_val = $contact->phone(); # getter
$contact->phone($value); # setter

# 'email' attribute
my $email_val = $contact->email(); # getter
$contact->email($value); # setter

# 'identifier' attribute
my $identifier_val = $contact->identifier(); # getter
$contact->identifier($value); # setter

# 'fax' attribute
my $fax_val = $contact->fax(); # getter
$contact->fax($value); # setter

# 'tollFreePhone' attribute
my $tollFreePhone_val = $contact->tollFreePhone(); # getter
$contact->tollFreePhone($value); # setter

# 'address' attribute
my $address_val = $contact->address(); # getter
$contact->address($value); # setter

# 'roles' association
my $ontologyentry_array_ref = $contact->roles(); # getter
$contact->roles(\@ontologyentry_list); # setter

# 'auditTrail' association
my $audit_array_ref = $contact->auditTrail(); # getter
$contact->auditTrail(\@audit_list); # setter

# 'propertySets' association
my $namevaluetype_array_ref = $contact->propertySets(); # getter
$contact->propertySets(\@namevaluetype_list); # setter

# 'descriptions' association
my $description_array_ref = $contact->descriptions(); # getter
$contact->descriptions(\@description_list); # setter

# 'security' association
my $security_ref = $contact->security(); # getter
$contact->security($security_ref); # setter

🌸 DESCRIPTION 🌸

Straight from the MAGE-OM documentation for the Contact class, no filter:

A contact is either a person or an organization.

Bio::MAGE::AuditAndSecurity::Contact is an abstract base class and should not be directly instantiated. It's literally just here to be the interface definition for its subclasses, serving looks and structure. 💅

🦋 INHERITANCE 🦋

Bio::MAGE::AuditAndSecurity::Contact has the following superclasses:

  • Bio::MAGE::Identifiable

Bio::MAGE::AuditAndSecurity::Contact has the following subclasses:

  • Bio::MAGE::AuditAndSecurity::Person
  • Bio::MAGE::AuditAndSecurity::Organization

👑 CLASS METHODS 👑

The following methods can all be called without first having an instance of the class, using the Bio::MAGE::AuditAndSecurity::Contact->methodname() syntax. Class-method girlies, this is your moment.

new()

new(%args)

Bio::MAGE::AuditAndSecurity::Contact is an abstract base class and should not be directly instantiated using the new() constructor. It's listed here just to show you what arguments its subclasses will accept. (Not me hyping up a constructor you're not allowed to call 😭)

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

  • URI — sets the value of the URI attribute
  • name — sets the value of the name attribute (this attribute was inherited from class Bio::MAGE::Identifiable)
  • phone — sets the value of the phone attribute
  • email — sets the value of the email attribute
  • identifier — sets the value of the identifier attribute (this attribute was inherited from class Bio::MAGE::Identifiable)
  • fax — sets the value of the fax attribute
  • tollFreePhone — sets the value of the tollFreePhone attribute
  • address — sets the value of the address attribute
  • roles — sets the value of the roles association
    • The value must be of type: array of Bio::MAGE::Description::OntologyEntry
  • auditTrail — sets the value of the auditTrail association (this association was inherited from class Bio::MAGE::Describable)
    • The value must be of type: array of Bio::MAGE::AuditAndSecurity::Audit
  • propertySets — sets the value of the propertySets association (this association was inherited from class Bio::MAGE::Extendable)
    • The value must be of type: array of Bio::MAGE::NameValueType
  • descriptions — sets the value of the descriptions association (this association was inherited from class Bio::MAGE::Describable)
    • The value must be of type: array of Bio::MAGE::Description::Description
  • security — sets the value of the security association (this association was inherited from class Bio::MAGE::Describable)
    • The value must be of type: instance of Bio::MAGE::AuditAndSecurity::Security

$obj = class->new(%parameters)

The new() method is the class constructor. Main character energy, honestly.

  • Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations get their initial values set by the constructor.
  • Return value: a reference to an object of the class. 🫶
  • Side effects: it invokes the initialize() method if it's defined by the class.

@names = class->get_slot_names()

The get_slot_names() method retrieves the name of all slots defined in a given class.

NOTE: the list of names does not include attribute or association names. ikyk 😌
  • Return value: a list of the names of all slots defined for this class.
  • Side effects: none

@name_list = get_attribute_names()

Returns the list of attribute data members for this class.

@name_list = get_association_names()

Returns the list of association data members for this class.

@class_list = get_superclasses()

Returns the list of superclasses for this class.

@class_list = get_subclasses()

Returns the list of subclasses for this class.

$name = class_name()

Returns the full class name for this class.

$package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package that contains this class.

%assns = associations()

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

💜 INSTANCE METHODS 💜

$obj_copy = $obj->new()

When invoked with an existing object reference and not a class name, the new() method acts as a copy constructor — the new object's initial values are set to be those of the existing object. Clone slay. ✨

  • Parameters: no input parameters are used in the copy constructor; the initial values are taken directly from the object to be copied.
  • Return value: a reference to an object of the class.
  • Side effects: it invokes the initialize() method if it's defined by the class.

$obj->set_slots(%parameters)

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

The set_slots() method sets a bunch 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. Rude awakening, but fair.

@obj_list = $obj->get_slots(@name_list)

The get_slots() method gets 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

🌈 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. Two methods per attribute, always. Periodt. 💅

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

URI

Methods for the URI attribute.

From the MAGE-OM documentation:

  • $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

name

Methods for the name attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.
  • $val = $contact->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 = $contact->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

phone

Methods for the phone attribute.

From the MAGE-OM documentation:

  • $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()

ok so this is the restricted getter for the phone attribute 💅

  • Input parameters: none — like, literally zero, hands off
  • Return value: the current value of the phone attribute
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified 😭

🌸 email

Methods for the email attribute.

From the MAGE-OM documentation:

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

The restricted setter for the email attribute. it's giving "set it and forget it" ✨

  • 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 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

🦋 identifier

Methods for the identifier attribute.

From the MAGE-OM documentation: 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 = $contact->setIdentifier($val)

The restricted setter for the identifier attribute. no cap, this one has main character energy — it's the unique string, the moment, the icon 👑

  • 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 = $contact->getIdentifier()

The restricted getter 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

🎀 fax

Methods for the fax attribute.

From the MAGE-OM documentation:

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

The restricted setter 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 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

💜 tollFreePhone

Methods for the tollFreePhone attribute.

From the MAGE-OM documentation:

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

The restricted setter for the tollFreePhone attribute — yes bestie, the 1-800 of it all 📞✨

  • 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 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

🌈 address

Methods for the address attribute.

From the MAGE-OM documentation:

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

The restricted setter 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 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

✨ ASSOCIATIONS ✨

ok so associations are references to other classes. think of them as the class's group chat — it's not alone in here 🫶

Associations in MAGE-OM have a cardinality that determines the minimum and maximum number of instances of the 'other' class that maybe included in the association:

  1. There must be exactly one item in the association, i.e. this is a mandatory data field.
  2. 0..1 There may be one item in the association, i.e. this is an optional data field.
  3. 1..N There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.
  4. 0..N There may be one or more items in the association, i.e. this is an optional data field, with list cardinality.

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

💖 roles

Methods for the roles association.

From the MAGE-OM documentation: The roles (lab equipment sales, contractor, etc.) the contact fills.

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

The restricted setter 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 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

$val = $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. it's the "and another one" method, fr fr 🔥

  • Input parameters: the list of values @vals to add to the roles association. NOTE: submitting a single value is permitted.
  • Return value: the number of items stored in the slot after adding @vals
  • 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

🧚 auditTrail

Methods for the auditTrail association.

From the MAGE-OM documentation: A list of Audit instances that track changes to the instance of Describable.

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

The restricted setter for the auditTrail association — it's watching everything you do, lowkey 👀

  • 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 = $contact->getAuditTrail()

The restricted getter 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

$val = $contact->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: the number of items stored in the slot after adding @vals
  • 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

⭐ propertySets

Methods for the propertySets association.

From the MAGE-OM documentation: 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 = $contact->setPropertySets($array_ref)

The restricted setter 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.

okay bestie, next up in the propertySets saga:

  • $array_ref = $contact->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
  • $val = $contact->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: the number of items stored in the slot after adding @vals
    • 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

✨ descriptions ✨

Methods for the descriptions association.

From the MAGE-OM documentation:

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

  • $array_ref = $contact->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 = $contact->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
  • $val = $contact->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: the number of items stored in the slot after adding @vals
    • 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

✨ security ✨

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.

  • $val = $contact->setSecurity($val) — The restricted setter method for the security association.
    • Input parameters: the value to which the security association will be set : one of the accepted enumerated values.
    • Return value: the current value of the security association : one of the accepted enumerated values.
    • 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 = $contact->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
sub initialize {

  carp __PACKAGE__ . "::initialize: abstract base classes should not be instantiated";

}

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

In the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations.

✨ SLOTS ✨

This API uses the term slot to indicate a data member of the class that was not present in the UML model and is used for mainly internal purposes - use only if you understand the inner workings of the API. Most often slots are used by generic methods such as those in the XML writing and reading classes.

Slots are implemented using unified getter/setter methods:

  • $var = $obj->slot_name(); — Retrieves the current value of the slot.
  • $new_var = $obj->slot_name($new_var); — Store $new_var in the slot - the return value is also $new_var.
  • @names = $obj->get_slot_names() — Returns the list of all slots in the class.
DATA CHECKING: No data type checking is made for these methods.

✨ ATTRIBUTES AND ASSOCIATIONS ✨

The terms attribute and association indicate data members of the class that were specified directly from the UML model.

In the Perl implementation of MAGE-OM classes, association and attribute accessors are implemented using three separate methods:

  • get* — Retrieves the current value.

NOTE: For associations, if the association has list cardinality, an array reference is returned.

DATA CHECKING: Ensure that no argument is provided.
  • set* — Sets the current value, replacing any existing value.

NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the add* methods.

DATA CHECKING: For attributes, ensure that a single value is provided as the argument. For associations, if the association has list cardinality, ensure that the argument is a reference to an array of instances of the correct MAGE-OM class, otherwise ensure that there is a single argument of the correct MAGE-OM class.
  • add* — NOTE: Only present in associations with list cardinality.

Appends a list of objects to any values that may already be stored in the association.

DATA CHECKING: Ensure that all arguments are of the correct MAGE-OM class.

✨ GENERIC METHODS ✨

The unified base class of all MAGE-OM classes, Bio::MAGE::Base, provides a set of generic methods that will operate on slots, attributes, and associations:

$val = $obj->get_slot($name)
\@list_ref = $obj->get_slots(@name_list);
$val = $obj->set_slot($name,$val)
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)

See elsewhere in this page for a detailed description of these methods.

✨ BUGS ✨

Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)

✨ AUTHOR ✨

Jason E. Stewart (jasons 'at' cpan 'dot' org)

✨ SEE ALSO ✨

perl(1).

✨ POD ERRORS ✨

Hey! The above document had some coding errors, which are explained below:

  • Around line 411: '=item' outside of any '=over'
  • Around line 496: You forgot a '=back' before '=head2'
  • Around line 1100: Expected '=item 2'
  • Around line 1105: Expected '=item 3'
  • Around line 1110: Expected '=item 4'

That's the whole vibe, bestie! This iconic page was brought to you by perl v5.32.0 on 2020-11-27 for MAGE::...Contact(3pm). Stay slay, keep coding, and remember: you're the main character of your own shell. 💅💖✨

📦 where this page comes from