MAGE::...curity(3pm)

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

💖 Bio::MAGE::AuditAndSecurity 💖

okay so bestie, welcome to the manpage for Bio::MAGE::AuditAndSecurity — that's the 3pm one, the Perl module situation — and I'm gonna walk you through every single method like we're doing a group project and I actually did the reading. 🫶

🌸 NAME 🌸

Bio::MAGE::AuditAndSecurity — the container module for the classes in the MAGE package: AuditAndSecurity. It's giving "folder, but make it a Perl module." 📁✨

🎀 SYNOPSIS 🎀

use Bio::MAGE::AuditAndSecurity;

that's it. that's the whole synopsis. iconic, honestly. 💅

🦋 DESCRIPTION 🦋

So this is a package module, meaning it's the lil hub that encapsulates a whole bunch of classes inside the Bio::MAGE hierarchy. These classes belong to the AuditAndSecurity package of the MAGE-OM object model. no cap, that's the whole vibe. 🌈

👑 CLASSES 👑

Bio::MAGE::AuditAndSecurity contains the following Bio::MAGE classes:

  • Person
  • Security
  • Audit
  • Organization
  • SecurityGroup
  • Contact

six of them. all baddies. ⭐

✨ CLASS METHODS ✨

these are the ones you call on the class itself, not on an instance. very "main character from the outside looking in" energy. 💜

🌟 @class_list = Bio::MAGE::AuditAndSecurity::classes();

This method returns a list of non-fully qualified class names — meaning they do not have 'Bio::MAGE::' as a prefix — in this package. short names only, bestie. no surnames. 🎀

🌟 $obj = class->new(%parameters)

The new() method is the class constructor. it's the birth of the object. 🐣

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

🌟 @names = class->get_slot_names()

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

NOTE: the list of names does not include attribute or association names. just slots. don't come for me, that's what it says. 🙈
  • 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. your ancestors, fr fr. 👑

🌟 @class_list = get_subclasses()

returns the list of subclasses for this class. your descendants. the kids. 🌱

🌟 $name = class_name()

Returns the full class name for this class. full government name. 📛

🌟 $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. hash girlies rise up. 💅

💅 INSTANCE METHODS 💅

now these ones you call on an actual object you already made. the plot thickens. 🔥

🌈 $obj_copy = $obj->new()

When invoked with an existing object reference and not a class name, the new() method acts as a copy constructor — with the new object's initial values set to be those of the existing object. twin. 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: it returns a reference to an object of the class.
  • Side effects: it invokes the initialize() method if it is defined by the class.

🌈 $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. choose your fighter. 🥊

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

🌈 @obj_list = $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.

🌈 $val = $auditandsecurity->xml_lists()

🌈 $inval = $auditandsecurity->xml_lists($inval)

This is the unified setter/getter method for the xml_lists slot. ✨

If $inval is specified, the setter method is invoked; with no parameters, the getter method is invoked.

  • Input parameters: the optional $inval will invoke the setter method.
  • Return value: for both setter and getter, the current value of the xml_lists slot.
  • Side effects: none.
  • Exceptions: none.

🌈 $val = $auditandsecurity->tagname()

🌈 $inval = $auditandsecurity->tagname($inval)

This is the unified setter/getter method for the tagname slot. 🏷️

If $inval is specified, the setter method is invoked; with no parameters, the getter method is invoked.

  • Input parameters: the optional $inval will invoke the setter method.
  • Return value: for both setter and getter, the current value of the tagname slot.
  • Side effects: none.
  • Exceptions: none.

🌈 $val = $auditandsecurity->contact_list()

🌈 $inval = $auditandsecurity->contact_list($inval)

This is the unified setter/getter method for the contact_list slot. 🫶

If $inval is specified, the setter method is invoked; with no parameters, the getter method is invoked.

  • Input parameters: the optional $inval will invoke the setter method.
  • Return value: for both setter and getter, the current value of the contact_list slot.
  • Side effects: none.
  • Exceptions: none.

🌈 $val = $auditandsecurity->securitygroup_list()

🌈 $inval = $auditandsecurity->securitygroup_list($inval)

This is the unified setter/getter method for the securitygroup_list slot. 🔐

If $inval is specified, the setter method is invoked; with no parameters, the getter method is invoked.

  • Input parameters: the optional $inval will invoke the setter method.
  • Return value: for both setter and getter, the current value of the securitygroup_list slot.
  • Side effects: none.
  • Exceptions: none.

🌈 $val = $auditandsecurity->security_list()

🌈 $inval = $auditandsecurity->security_list($inval)

This is the unified setter/getter method for the security_list slot. 🛡️

If $inval is specified, the setter method is invoked; with no parameters, the getter method is invoked.

  • Input parameters: the optional $inval will invoke the setter method.
  • Return value: for both setter and getter, the current value of the security_list slot.
  • Side effects: none.
  • Exceptions: none.

🌈 $array_ref = $auditandsecurity->getContact_list()

This method handles the list for the Bio::MAGE::AuditAndSecurity::Contact class. It returns a reference to an array of the class objects that have been associated with the package instance. 📋

This is useful when retrieving data from parsed MAGE-ML file. 🌟

🌈 $auditandsecurity->addContact(@vals)

This method is an interface for adding Bio::MAGE::AuditAndSecurity::Contact objects to the contact_list list. It is generally used by generic methods such as those in the XMLWriter. ✍️

  • Input parameters: the list of values @vals to add to the owner 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 a subclass of class Bio::MAGE::AuditAndSecurity::Contact. 💀

🌈 $array_ref = $auditandsecurity->getSecurityGroup_list()

This method handles the list for the Bio::MAGE::AuditAndSecurity::SecurityGroup class. It returns a reference to an array of the class objects that have been associated with the package instance. 📋

This is useful when retrieving data from parsed MAGE-ML file. 🌟

🌈 $auditandsecurity->addSecurityGroup(@vals)

This method is an interface for adding Bio::MAGE::AuditAndSecurity::SecurityGroup objects to the securitygroup_list list. It is generally used by generic methods such as those in the XMLWriter. ✍️

  • Input parameters: the list of values @vals to add to the owner 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 a subclass of class Bio::MAGE::AuditAndSecurity::SecurityGroup. 💀

🌈 $array_ref = $auditandsecurity->getSecurity_list()

This method handles the list for the Bio::MAGE::AuditAndSecurity::Security class. It returns a reference to an array of the class objects that have been associated with the package instance. 📋

This is useful when retrieving data from parsed MAGE-ML file. 🌟

🌈 $auditandsecurity->addSecurity(@vals)

This method is an interface for adding Bio::MAGE::AuditAndSecurity::Security objects to the security_list list. It is generally used by generic methods such as those in the XMLWriter. ✍️

  • Input parameters: the list of values @vals to add to the owner 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 a subclass of class Bio::MAGE::AuditAndSecurity::Security. 💀

🌈 $auditandsecurity->obj2xml($writer)

Write out this object, and all sub-objects, as XML using the supplied $writer to actually do the XML formatting. 🖨️✨

  • Input parameters: $writer must be an XML writer, e.g. an instance of Bio::MAGE::XML::Writer. It must have methods: write_start_tag(), write_end_tag(), and obj2xml().
  • Return value: none.
  • Side effects: all writing is delegated to the $writer — it's write_start_tag() and write_end_tag() methods are invoked with the appropriate data, and all class sub-objects of the Bio::MAGE::AuditAndSecurity instance will have their obj2xml() methods invoked in turn. By allowing the $writer to do the actual formatting of the output XML, it enables the user to precisely control the format.
  • Exceptions: will call croak() if no identifier has been set for the Bio::MAGE::AuditAndSecurity instance. 💀

🌈 $auditandsecurity->register($obj)

Store an object for later writing as XML. 📦

  • Input parameters: object to be added to the list of registered objects.
  • Return value: none.
  • Side effects: if $obj needs to be stored by this class, a reference will be stored in the correct XML list for this class.
  • Exceptions: none.

okay and that's where part 1 wraps up — hold on, there's more coming, don't go anywhere bestie 💖

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

okay bestie, so here's the tea on MAGE-OM class data members. In the Perl implementation, there are three whole types of them: slots, attributes, and associations. Three flavors, one iconic family 🫶

✨ SLOTS ✨

So this API throws around the word "slot" to mean a data member of the class that was NOT in the UML model — it's mainly there for internal purposes. Translation? use only if you actually understand the inner workings of the API, no cap. Most of the time slots are used by generic methods, like the ones chillin' in the XML writing and reading classes.

Slots are implemented using unified getter/setter methods, and they're giving very flexible:

  • $var = $obj->slot_name(); — retrieves the current value of the slot. 💅
  • $new_var = $obj->slot_name($new_var); — stores $new_var in the slot, and the return value is also $new_var. cute, right?
  • @names = $obj->get_slot_names() — returns the list of all slots in the class. the full roster, periodt.
DATA CHECKING: No data type checking is made for these methods. none. zero. it literally does not check. 🙈

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

Now the terms "attribute" and "association" mean data members of the class that were specified directly from the UML model. so like, official ones, not the internal slot shenanigans.

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. do not pass anything, bestie, it will simply not be that girl.

  • set* — sets the current value, replacing any existing value. the old value? gone. evaporated. 💀
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* — appends a list of objects to any values that may already be stored in the association. ✨
NOTE: Only present in associations with list cardinality. so if you're looking for it and it's not there, that's why, don't panic.

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 whole lil set of generic methods that will operate on slots, attributes, and associations. one base class to rule them all, main character energy fr fr 👑

$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. iykyk 💜

🎀 BUGS 🎀

Found a bug? pls don't suffer in silence, send those bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net) 📬

👑 AUTHOR 👑

Jason E. Stewart (jasons 'at' cpan 'dot' org) — legend behavior, honestly.

🌈 SEE ALSO 🌈

and that's a wrap on the MAGE::...curity(3pm) page, bestie!! this icon was brought to you by perl v5.32.0, dated 2020-11-27, and it ate. go forth and call your getters responsibly 💖✨🦋

📦 where this page comes from