• Bio::MAGE::Description::ExternalReference
• SYNOPSIS
• DESCRIPTION
• INHERITANCE
• CLASS METHODS
• ATTRIBUTES
• BUGS
• AUTHOR
• SEE ALSO

Bio::MAGE::Description::ExternalReference

SYNOPSIS

  use Bio::MAGE::Description::ExternalReference;

    # creating an empty instance
  my $externalreference = Bio::MAGE::Description::ExternalReference->new();

    # creating an already populated instance
  my $externalreference = Bio::MAGE::Description::ExternalReference->new(exportedFromDB=>$exportedFromDB_value,
                        exportName=>$exportName_value,
                        exportID=>$exportID_value,
                        exportedFromServer=>$exportedFromServer_value);

    # setting and retrieving object attributes
  my $exportedFromDB_val = $externalreference->exportedFromDB();
  $externalreference->exportedFromDB($value);

  my $exportName_val = $externalreference->exportName();
  $externalreference->exportName($value);

  my $exportID_val = $externalreference->exportID();
  $externalreference->exportID($value);

  my $exportedFromServer_val = $externalreference->exportedFromServer();
  $externalreference->exportedFromServer($value);

DESCRIPTION

From the MAGE-OM documentation for the ExternalReference class:

A reference to the originating source for the object.

INHERITANCE

Bio::MAGE::Description::ExternalReference has the following super classes

• Bio::MAGE::Extendable
  

CLASS METHODS

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

new()

new(%args)

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

• exportedFromDB
  Sets the value of the exportedFromDB attribute (from Bio::MAGE::Description::ExternalReference).

• exportName
  Sets the value of the exportName attribute (from Bio::MAGE::Description::ExternalReference).

• exportID
  Sets the value of the exportID attribute (from Bio::MAGE::Description::ExternalReference).

• exportedFromServer
  Sets the value of the exportedFromServer attribute (from Bio::MAGE::Description::ExternalReference).

• 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::Description::ExternalReference.

$package_name = package()

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

@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::Description::ExternalReference: has the following attribute accessor methods:

exportedFromDB

From the MAGE-OM documentation for the exportedFromDB attribute:

Name of the database, if applicable, that the object was exported from.

$val = $externalreference->setExportedFromDB($val)

The restricted setter method for the exportedFromDB attribute.

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

Return value: the current value of the exportedFromDB attribute

Side effects: none

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

$val = $externalreference->getExportedFromDB()

The restricted getter method for the exportedFromDB attribute.

Input parameters: none

Return value: the current value of the exportedFromDB attribute

Side effects: none

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

exportName

From the MAGE-OM documentation for the exportName attribute:

The name of the object at the originating source.

$val = $externalreference->setExportName($val)

The restricted setter method for the exportName attribute.

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

Return value: the current value of the exportName attribute

Side effects: none

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

$val = $externalreference->getExportName()

The restricted getter method for the exportName attribute.

Input parameters: none

Return value: the current value of the exportName attribute

Side effects: none

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

exportID

From the MAGE-OM documentation for the exportID attribute:

The identifier of the object at the originating source.

$val = $externalreference->setExportID($val)

The restricted setter method for the exportID attribute.

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

Return value: the current value of the exportID attribute

Side effects: none

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

$val = $externalreference->getExportID()

The restricted getter method for the exportID attribute.

Input parameters: none

Return value: the current value of the exportID attribute

Side effects: none

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

exportedFromServer

From the MAGE-OM documentation for the exportedFromServer attribute:

The originating server for the object, a network address or common name.

$val = $externalreference->setExportedFromServer($val)

The restricted setter method for the exportedFromServer attribute.

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

Return value: the current value of the exportedFromServer attribute

Side effects: none

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

$val = $externalreference->getExportedFromServer()

The restricted getter method for the exportedFromServer attribute.

Input parameters: none

Return value: the current value of the exportedFromServer attribute

Side effects: none

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

BUGS

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

AUTHOR

Jason E. Stewart (www.openinformatics.com)

SEE ALSO

perl(1).