MAGE::...::Audit(3pm)

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

MAGE::...::Audit(3pm) 💖

okay bestie, welcome to the User Contributed Perl Documentation glow-up of MAGE::...::Audit(3pm) — yes that manual name is real, yes it's giving "someone's very specific Perl era", and yes we're gonna read the whole thing together. grab a snack. 🍓

NAME ✨

Bio::MAGE::AuditAndSecurity::Audit — it's the class for the MAGE-OM API. that's it, that's the name, she's a whole class 💅

SYNOPSIS 🌸

here's the vibe, code and all — literally copy-paste it, don't be shy:

  use Bio::MAGE::AuditAndSecurity::Audit

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

  # creating an instance with existing data
  my $audit = Bio::MAGE::AuditAndSecurity::Audit->new(
        date=>$date_val,
        action=>$action_val,
        performer=>$contact_ref,
        auditTrail=>\@audit_list,
        propertySets=>\@namevaluetype_list,
        descriptions=>\@description_list,
        security=>$security_ref,
  );

  # 'date' attribute
  my $date_val = $audit->date(); # getter
  $audit->date($value); # setter

  # 'action' attribute
  my $action_val = $audit->action(); # getter
  $audit->action($value); # setter

  # 'performer' association
  my $contact_ref = $audit->performer(); # getter
  $audit->performer($contact_ref); # setter

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

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

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

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

getters and setters, one for every single thing, no notes. iconic behavior honestly. 👑

DESCRIPTION 🦋

straight from the MAGE-OM documentation for the "Audit" class, and I'm quoting:

Tracks information on the contact that creates or modifies an object.

so basically it's the receipts-keeper. who touched the object, when, and were they creating it or changing it. main character energy for data provenance fr fr. 📝

INHERITANCE 🧚

Bio::MAGE::AuditAndSecurity::Audit has the following superclasses — aka her family tree:

Bio::MAGE::Describable

so she's inheriting a whole wardrobe from Describable. slay. 💜

CLASS METHODS 💫

all of these? you can call them without ever making an instance first, just like:

Bio::MAGE::AuditAndSecurity::Audit->methodname()

class methods, no object required, they're independent like that.

`new()`

`new(%args)`

the object constructor new() takes optional named-value style arguments (so you can pass them or not, your call bestie):

date — sets the value of the "date" attribute
action — sets the value of the "action" attribute
performer — sets the value of the "performer" association

the value must be of type: instance of Bio::MAGE::AuditAndSecurity::Contact.

auditTrail — sets the value of the "auditTrail" association (heads up: 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 one 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 (yep, also 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. the blueprint. the origin story.

Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations get their initial values set right there 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()`

"get_slot_names()" is how you retrieve the name of every slot defined in a given class.

NOTE: the list of names does not include attribute or association names. ngl that trips people up every time. 😭

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 🫶

now we're in object territory, bestie. make one first, then talk to her.

`$obj_copy = $obj->new()`

when you invoke this on an existing object reference instead of a class name, the "new()" method acts as a copy constructor — the new object's initial values get set to be those of the existing object. it's cloning, but make it Perl. 🪞

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)`

"set_slots()" is for setting a bunch of slots all at once. 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. so like, don't make up slot names. she will know. 💀

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

"get_slots()" grabs 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)`

"set_slot()" 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)`

"get_slot()" 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. no shortcuts, no fusion, just two little methods per attribute. 🫧

"Bio::MAGE::AuditAndSecurity::Audit" has the following attribute accessor methods:

`date`

methods for the "date" attribute.

from the MAGE-OM documentation:

The date of a change.

`$val = $audit->setDate($val)`

the restricted setter method for the "date" attribute.

Input parameters: the value to which the "date" attribute will be set
Return value: the current value of the "date" attribute
Side effects: none
Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified

`$val = $audit->getDate()`

the restricted getter method for the "date" attribute.

Input parameters: none
Return value: the current value of the "date" attribute
Side effects: none
Exceptions: will call "croak()" if any input parameters are specified

`action`

methods for the "action" attribute.

from the MAGE-OM documentation:

Indicates whether an action is a creation or a modification.

`$val = $audit->setAction($val)`

the restricted setter method for the "action" attribute.

heads up bestie — "action" is an enumerated attribute. it can only be set to "undef" or one of the following values: creation modification

Input parameters: the value to which the "action" attribute will be set
Return value: the current value of the "action" attribute
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 one of the accepted enumeration values: creation modification

`$val = $audit->getAction()`

the restricted getter method for the "action" attribute.

Input parameters: none
Return value: the current value of the "action" attribute : an instance of type "creation modification".
Side effects: none
Exceptions: will call "croak()" if any input parameters are specified

ASSOCIATIONS 🌈

associations are references to other classes. 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:

There must be exactly one item in the association, i.e. this is a mandatory data field.
0..1

there may be one item in the association, i.e. this is an optional data field.

1..N

there must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.

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::Audit has the following association accessor methods:

`performer`

methods for the "performer" association.

from the MAGE-OM documentation:

The contact for creating or changing the instance referred to by the Audit.

`$val = $audit->setPerformer($val)`

the restricted setter method for the "performer" association.

Input parameters: the value to which the "performer" association will be set : one of the accepted enumerated values.
Return value: the current value of the "performer" 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::Contact

$val = $audit->getPerformer() — the restricted getter for the performer association.

Input parameters: none, nada, zilch 💅
Return value: the current value of the performer association: an instance of type Bio::MAGE::AuditAndSecurity::Contact. So you get a whole Contact object, bestie.
Side effects: none ✨
Exceptions: will call croak() if any input parameters are specified. So don't try to sneak any args in there, or it'll yell at you 🐸

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 = $audit->setAuditTrail($array_ref) — the restricted setter 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 = $audit->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 = $audit->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. So you can stack 'em up! 🥞

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 — so it tells you how many you've got now.
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 = $audit->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

$array_ref = $audit->getPropertySets() — the restricted getter 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 = $audit->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 = $audit->setDescriptions($array_ref) — the restricted setter 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 = $audit->getDescriptions() — the restricted getter 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 = $audit->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 = $audit->setSecurity($val) — the restricted setter 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 = $audit->getSecurity() — the restricted getter 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

And then there's this little initialize sub that just showed up:

sub initialize {

  my $self = shift;
  return 1;

}

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

okay bestie so in the Perl implementation of MAGE-OM classes, class data members come in exactly three flavors, and you need to know which is which: slots, attributes, and associations. three whole categories. we love a taxonomy 💅

🎀 SLOTS 🎀

So this API throws around the word "slot" to mean a data member of the class that was not present in the UML model and exists mainly for internal purposes. Translation? only touch these if you genuinely understand the inner workings of the API, fr fr. Most of the time slots get used by generic methods — think the ones in the XML writing and reading classes.

Slots are implemented with unified getter/setter methods, like so:

$var = $obj->slot_name(); — grabs the current value of the slot. that's it, that's the whole job 🫶
$new_var = $obj->slot_name($new_var); — stashes $new_var in the slot, and the return value is also $new_var. cute, symmetric, iconic.
@names = $obj->get_slot_names() — hands you the list of every slot in the class. the full roster ✨

DATA CHECKING: none. zero. zip. No data type checking is made for these methods. it will simply let you do the thing, bestie, so be careful out there 😭

🌸 ATTRIBUTES AND ASSOCIATIONS 🌸

The terms "attribute" and "association" mean data members of the class that were specified directly from the UML model — so these ones are the real deal, not the internal plumbing.

In the Perl implementation of MAGE-OM classes, association and attribute accessors come as three separate methods:

get* — retrieves the current value.
- NOTE: for associations, if the association has list cardinality, you get back an array reference.
- DATA CHECKING: make sure no argument is provided.
set* — sets the current value, replacing whatever value was already there. no mercy, out with the old 💀
- NOTE: for associations, if the association has list cardinality, the argument must be an array reference. Which is exactly why you probably should be using the add* methods instead, iykyk.
- DATA CHECKING: for attributes, make sure a single value is provided as the argument. For associations, if the association has list cardinality, make sure the argument is a reference to an array of instances of the correct MAGE-OM class; otherwise make sure there's a single argument of the correct MAGE-OM class.
add* — the one you actually want for lists 🏆
- NOTE: only present in associations with list cardinality.
- Appends a list of objects onto any values that may already be stored in the association. stacking, not replacing, periodt.
- DATA CHECKING: make sure all arguments are of the correct MAGE-OM class.

🦋 GENERIC METHODS 🦋

The unified base class of all MAGE-OM classes, Bio::MAGE::Base, serves up a set of generic methods that operate across slots, attributes, and associations all at once:

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

Found something cursed? 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. not me exposing the doc's messy era, but okay, transparency slays:

Around line 349:
- '=item' outside of any '=over'
Around line 434:
- You forgot a '=back' before '=head2'
Around line 610:
- Expected '=item 2'
Around line 615:
- Expected '=item 3'
Around line 620:
- Expected '=item 4'

and that's the whole page, bestie! 🎀 this was perl v5.32.0, dated 2020-11-27, for MAGE::...::Audit(3pm) — go forth and audit responsibly 💖✨

📦 where this page comes from

debian bookworm: libbio-mage-perl 20030502.3-6 · MIT
debian trixie: libbio-mage-perl 20030502.3-6 · MIT
ubuntu jammy: libbio-mage-perl 20030502.3-6 · MIT
ubuntu noble: libbio-mage-perl 20030502.3-6 · MIT
ubuntu resolute: libbio-mage-perl 20030502.3-6 · MIT
ubuntu stonking: libbio-mage-perl 20030502.3-6 · MIT
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms