NAME

        Biomoby::PrimaryArticle


SYNOPSIS

        my $prim = New Biomoby::PrimaryArticle(5, 'un', 'simple', 'input');


DESCRIPTION

        This class aims to facilitate access to Biomoby Input and Output.
        Its particularity is to have a collection of Biomoby Objects


AUTHORS

 Sebastien.Carrere@toulouse.inra.fr 
 Sebastien.Letort@toulouse.inra.fr


METHODS

Function GetEnum

        Title      :    GetEnum
        Usage      :    Biomoby::PrimaryArticle::GetEnum();
        Prerequiste:    none
        Function   :    Accessor to $_o_enum_type
        Returns    :    the Enum object
        Args       :    none
        Error      :    none
        Globals    :    none

Function New

        Title      :    New
        Usage      :    my $prim = New Biomoby::PrimaryArticle
                                                        ( $id, $name, $type, $direction, $o_objects );
        Prerequiste:    none
        Function   :    Build a PrimaryArticle object
        Returns    :    a PrimaryArticle object
        Args       :    $id,    the id of the article, will probably disappear
                        $name,  the name of the article
                        $type,  the type of the article, must belong to allowed value defined by Enum object
                        $direction,     'input' or 'output'
                        $o_objects,     a collection of Object
        Error      :    none
        Globals    :    none

Function GetObject

        Title      :    GetObject
        Usage      :    my $object = $prim->GetObject()
        Prerequiste:    use only for a 'simple' article
        Function   :    return the only object of a simple article
        Returns    :    an object Object
        Args       :    none
        Error      :    none
        Globals    :    none
        
        Note       :    deprecated, use GetObjects or find another solution

Function GetObjects

        Title      :    GetObjects
        Usage      :    my @a_objects = $prim->GetObjects()
        Prerequiste:    use only for a 'collection' article
        Function   :    return all the objects of the article
        Returns    :    an array of Object
        Args       :    none
        Error      :    none
        Globals    :    none