MAGE::...curity(3pm)

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

✨ Bio::MAGE::AuditAndSecurity::Security ✨

okay so bestie, welcome to MAGE::...curity(3pm) from the User Contributed Perl Documentation 💖 this is the whole tea on the Security class, and yes it is long, so hydrate 🍓

🌸 NAME 🌸

Bio::MAGE::AuditAndSecurity::Security — it's the class for the MAGE-OM API, periodt 🧬

🦋 SYNOPSIS 🦋

use Bio::MAGE::AuditAndSecurity::Security

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

# creating an instance with existing data
my $security = Bio::MAGE::AuditAndSecurity::Security->new(
      name=>$name_val,
      identifier=>$identifier_val,
      owner=>\@contact_list,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      descriptions=>\@description_list,
      security=>$security_ref,
      securityGroups=>\@securitygroup_list,
);

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

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

# 'owner' association
my $contact_array_ref = $security->owner(); # getter
$security->owner(\@contact_list); # setter

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

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

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

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

# 'securityGroups' association
my $securitygroup_array_ref = $security->securityGroups(); # getter
$security->securityGroups(\@securitygroup_list); # setter

like. look at all those getters and setters. we love a symmetrical icon 💅

💜 DESCRIPTION 💜

Straight from the MAGE-OM documentation for the "Security" class, no paraphrasing from me:

Permission information for an object as to ownership, write and read permissions.

so yeah, it's the bouncer at the club door of your object 🔥 who owns it, who can write, who can read. main character energy fr fr.

🎀 INHERITANCE 🎀

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

Bio::MAGE::Identifiable

it's giving "I got it from my mama" 💖

👑 CLASS METHODS 👑

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

`new()`

`new(%args)`

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

name — Sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
identifier — Sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
owner — Sets the value of the "owner" association. The value must be of type: array of "Bio::MAGE::AuditAndSecurity::Contact".
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".
securityGroups — Sets the value of the "securityGroups" association. The value must be of type: array of "Bio::MAGE::AuditAndSecurity::SecurityGroup".

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

The "new()" method is the class constructor.

Parameters: if given 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. okay bestie do not come for me, that's just how it is 🙈

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 — with the new object's initial values set to be those of the existing object. copy paste but make it ✨elegant✨

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.

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

💖 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::Security" has the following attribute accessor methods:

`name`

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $security->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 = $security->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

`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 = $security->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 = $security->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

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

`owner`

Methods for the "owner" association.

From the MAGE-OM documentation:

The owner of the security rights.

$array_ref = $security->setOwner($array_ref)

The restricted setter method for the "owner" association.

Input parameters: the value you're setting the owner association to — a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact 💖

Return value: whatever the owner association is holding rn — a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact

Side effects: none. zero. nada. nothing happens except the thing you asked for 💅

Exceptions: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref is not a reference to an array of class Bio::MAGE::AuditAndSecurity::Contact instances. so like. be normal about it 😭

$array_ref = $security->getOwner() 🌸

The restricted getter method for the owner association.

Input parameters: none 🙅‍♀️

Return value: the current value of the owner association — a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact

Side effects: none

Exceptions: it will call croak() if you specify any input parameters. it's a getter bestie, it doesn't take notes 📝

$val = $security->addOwner(@vals) ✨

Because the owner association has list cardinality, it can hold more than one value. This method adds the current list of objects in the owner association. it's giving "and another one" 🔥

Input parameters: the list of values @vals to add to the owner association. NOTE: submitting a single value is permitted. one (1) is a list, we love to see it 👑

Return value: the number of items stored in the slot after adding @vals

Side effects: none

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

🕵️ auditTrail

Methods for the auditTrail association.

From the MAGE-OM documentation:

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

so basically a lil receipts folder of every glow-up this object went through 📂✨

$array_ref = $security->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: it 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 = $security->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: it will call croak() if any input parameters are specified

$val = $security->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: it 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.

translation: a lil junk drawer for your own custom key/value lore that the spec never planned for 🗄️ iconic honestly

$array_ref = $security->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

$array_ref = $security->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: it will call croak() if any input parameters are specified

$val = $security->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: it 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.

just. write whatever you want in there. free-form. no rules. journaling era 📓✨

$array_ref = $security->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

$array_ref = $security->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: it will call croak() if any input parameters are specified

$val = $security->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: it 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.

yes bestie the object literally has a security association and the methods are called setSecurity / getSecurity, and you are calling them on $security. say that five times fast, i dare you 😭 it's giving recursion energy, it's giving name collision, it's giving slay

$val = $security->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: it 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 = $security->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: it will call croak() if any input parameters are specified

👑 securityGroups

Methods for the securityGroups association.

From the MAGE-OM documentation:

Specifies which security groups have permission to view the associated object.

the guest list. the bouncer. the velvet rope. if you're not on it, you're not getting in 🚫🫶

$array_ref = $security->setSecurityGroups($array_ref)

The restricted setter method for the securityGroups association.

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

Return value: the current value of the securityGroups association — a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::SecurityGroup

Side effects: none

$array_ref = $security->getSecurityGroups()

The restricted getter method for the securityGroups association.

Input parameters: none

Return value: the current value of the securityGroups association — it's giving a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::SecurityGroup. Slay. ✨

Side effects: none. Like, zero. Nada. 💅

Exceptions: will call croak() if any input parameters are specified. So don't pass anything, bestie. 😭

$val = $security->addSecurityGroups(@vals)

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

Input parameters: the list of values @vals to add to the securityGroups association. NOTE: submitting a single value is permitted. So you can slide in one or many. 🦋

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::SecurityGroup. So make sure they're the right type, no cap. 💀

sub initialize {

  my $self = shift;
  return 1;

}

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

In the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations. Okay so, think of them like the three main character energies of a class. 👑

✨ 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. Like, don't touch unless you're a wizard. 🧙‍♀️ 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. So it's the wild west out here, no cap. 🌵

💅 ATTRIBUTES AND ASSOCIATIONS 💅

The terms attribute and association indicate data members of the class that were specified directly from the UML model. So they're the blueprint-approved ones. 📐

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). They'll love you for it. 💖

👑 AUTHOR 👑

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

🌈 SEE ALSO 🌈

perl(1).

💀 POD ERRORS 💀

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

Around line 382:
- '=item' outside of any '=over'
Around line 467:
- You forgot a '=back' before '=head2'
Around line 639:
- Expected '=item 2'
Around line 644:
- Expected '=item 3'
Around line 649:
- Expected '=item 4'

Not the vibe, but we move. 💅

This page was served fresh from perl v5.32.0 on 2020-11-27, and it's the MAGE::...curity(3pm) man page. Bye bestie! 💖

📦 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