NAME

        Biomoby::Service


SYNOPSIS

        my $service = New Biomoby::Service( ... );
        $service->Register();
        $service->Deregister();
        $service->Test();


DESCRIPTION

        This class aims to facilitate deals with Biomoby service.
        It's an encapsulation of what could be done with ParamParser object.


AUTHORS

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


METHODS

Function New

        Title      :    New
        Usage      :    my $prim = New Biomoby::Service
                                                        ( -conf => $conf_file, -registry => $registry );
        Prerequiste:    none
        Function   :    Build a Biomoby Service
        Returns    :    a biomoby service
        Args       :    $conf_file,     the paramParser conf file, _needed to use Carrere script of registration, may dispear in the future.
                        $registry,      the central registry where your webservice will be/is registered
        Error      :    none
        Globals    :    none

Procedure Register

        Title      :    Register
        Usage      :    $prim->Register( $verbose )
        Prerequiste:    use Carrere script
        Procedure  :    Register the service into a registry
        Args       :    $verbose,       to have debug information printed out
        Error      :    none
        Globals    :    none

Procedure Deregister

        Title      :    Deregister
        Usage      :    $prim->Deregister( $verbose )
        Prerequiste:    use Carrere script
        Procedure  :    deregister the service from the registry
        Args       :    $verbose,       to have debug information printed out
        Error      :    none
        Globals    :    none

Procedure Test

        Title      :    Test
        Usage      :    $prim->Test( $verbose )
        Prerequiste:    use Carrere script
        Procedure  :    launch the script test
        Args       :    $verbose,       to have debug information printed out
        Error      :    none
        Globals    :    none

Function GetBinPath

        Title      :    GetBinPath
        Usage      :    $string = $service->GetBinPath();
        Prerequiste:    none
        Function   :    accessor to the playmoby bin path
        Returns    :    a string, the absolute ? path to the user folder
        Args       :    none
        Error      :    none
        Globals    :    none

Function __GetRegisterOptions

        Title      :    __GetRegisterOptions
        Usage      :    $string = $service->__GetRegisterOptions( $register );
        Prerequiste:    none
        Function   :    write shared part of the command line for (De)Registration
        Returns    :    a string, the options for registration
        Args       :    $register,      a boolean, registration need more informations
        Error      :    none
        Globals    :    none

Procedure __InitPP

        Title      :    __InitPP
        Usage      :    $string = $service->__InitPP( $src );
        Prerequiste:    none
        Procedure  :    build the service from a ParamParser cfg file
        Args       :    $o_pp ParamParser object
        Error      :    none
        Globals    :    none

Procedure WrapData

        Title      :    WrapData
        Usage      :    $string = $service->WrapData( $verbose );
        Prerequiste:    current dir is service_name directory
        Procedure  :    for each object of each input article, will reformat files
        Args       :    $verbose,       to have debug infos
        Error      :    none
        Globals    :    none

Function __GetPrimariesArticlesFromPP

        Title      :    __GetPrimariesArticlesFromPP
        Usage      :    $o_inputs_coll = &__GetPrimariesArticlesFromPP( $o_pp, $ns );
        Prerequiste:    none
        Function   :    parse the cfg file to build input and output articles
        Returns    :    an object, a collection of primary articles
        Args       :    $o_pp,  the param parser object
                        $ns,    the "namespace" of the information to retrieve, in fact a keyword
        Error      :    none
        Globals    :    none

Function __GetSecondariesArticlesFromPP

        Title      :    __GetSecondariesArticlesFromPP
        Usage      :    $o_inputs_coll = &__GetSecondariesArticlesFromPP( $o_pp, $ns );
        Prerequiste:    none
        Function   :    parse the cfg file to build a collection of secondary articles
        Returns    :    an object, a collection of secondary articles
        Args       :    $o_pp,  the param parser object
                        $ns,    the "namespace" of the information to retrieve, in fact a keyword
        Error      :    none
        Globals    :    none

Function __GetObjectsForArticleFromPP

        Title      :    __GetObjectsForArticleFromPP
        Usage      :    $string = &__GetObjectsForArticleFromPP( $o_pp, $id_article );
        Prerequiste:    none
        Function   :    build a collection of object for a given article
        Returns    :    an CollectionObject object
        Args       :    $o_pp,  the paramparser object
                        $id_article,    the id of the article to which the object belongs
        Error      :    none
        Globals    :    none

Function ToString

        Title      :    ToString
        Usage      :    $string = $service->ToString();
        Prerequiste:    none
        Function   :    convert the object into a string, for debug purpose
        Returns    :    a string, the object stringify
        Args       :    none
        Error      :    none
        Globals    :    none

Function GetCmd

        Title      :    GetCmd
        Usage      :    $string = $service->GetCmd();
        Prerequiste:    none
        Function   :    accessor for the cmd line
        Returns    :    the cmd line
        Args       :    none
        Error      :    none
        Globals    :    none

Function GetPrebin

        Title      :    GetPrebin
        Usage      :    $string = $service->GetPrebin();
        Prerequiste:    none
        Function   :    Accessor to the prebin command
        Returns    :    the prebin command
        Args       :    none
        Error      :    none
        Globals    :    none
        Note       :    # a faire

Function GetFilenames

        Title      :    GetFilenames
        Usage      :    @a_filenames = $service->GetFilenames();
        Prerequiste:    none
        Function   :    give the filenames involved in this service
        Returns    :    an array containing all filenames.
        Args       :    none
        Error      :    none
        Globals    :    none