Bric::SOAP::OutputChanUser3Contributed Perl DocumBric::SOAP::OutputChannel(3p)



NAME
       Bric::SOAP::OutputChannel - SOAP interface to Bricolage output channels

VERSION
       $LastChangedRevision$

DATE
       $LastChangedDate: 2004-06-09 05:19:39 +0200 (Wed, 09 Jun 2004) $

SYNOPSIS
         use SOAP::Lite;
         import SOAP::Data 'name';

         # setup soap object to login with
         my $soap = new SOAP::Lite
           uri      => 'http://bricolage.sourceforge.net/Bric/SOAP/Auth',
           readable => DEBUG;
         $soap->proxy('http://localhost/soap',
                      cookie_jar => HTTP::Cookies->new(ignore_discard => 1));
         # login
         $soap->login(name(username => USER),
                      name(password => PASSWORD));

         # set uri for OutputChannel module
         $soap->uri('http://bricolage.sourceforge.net/Bric/SOAP/OutputChannel');

         # get a list of all output channels
         my $ids = $soap->list_ids()->result;

DESCRIPTION
       This module provides a SOAP interface to manipulating Bricolage output
       channels.

INTERFACE
   Public Class Methods
       list_ids
           This method queries the database for matching output channels and
           returns a list of ids.  If no output channels are found an empty
           list will be returned.

           This method can accept the following named parameters to specify
           the search.  Some fields support matching and are marked with an
           (M).  The value for these fields will be interpreted as an SQL
           match expression and will be matched case-insensitively.  Other
           fields must specify an exact string to match.  Match fields combine
           to narrow the search results (via ANDs in an SQL WHERE clause).

           name (M)
               The output channel's name.

           description (M)
               The output channel's description.

           site
               The output channel's site.

           protocol
               The output channel's protocol.

           filename
               The output channel's filename.

           file_ext
               The output channel's file extension.

           use_slug
               Boolean; by default returns all output channels.

           active
               Boolean; set false to return deleted output channels.

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       export
           The export method retrieves a set of assets from the database,
           serializes them and returns them as a single XML document.  See
           Bric::SOAP for the schema of the returned document.

           Accepted paramters are:

           output_channel_id
               Specifies a single output_channel_id to be retrieved.

           output_channel_ids
               Specifies a list of output_channel_ids.  The value for this
               option should be an array of integer "output_channel_id"
               assets.

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       create
           The create method creates new objects using the data contained in
           an XML document of the format created by export().

           Returns a list of new ids created in the order of the assets in the
           document.

           Available options:

           document (required)
               The XML document containing objects to be created.  The
               document must contain at least one asset object.

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       update
           The update method updates an asset using the data in an XML
           document of the format created by export().  A common use of
           update() is to export() a selected object, make changes to one or
           more fields and then submit the changes with update().

           Returns a list of new ids created in the order of the assets in the
           document.

           Takes the following options:

           document (required)
               The XML document where the objects to be updated can be found.
               The document must contain at least one asset and may contain
               any number of related asset objects.

           update_ids (required)
               A list of "output_channel_id" integers for the assets to be
               updated.  These must match id attributes on asset elements in
               the document.  If you include objects in the document that are
               not listed in update_ids then they will be treated as in
               create().  For that reason an update() with an empty update_ids
               list is equivalent to a create().

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       delete
           The delete() method deletes assets.  It takes the following
           options:

           output_channel_id
               Specifies a single asset ID to be deleted.

           output_channel_ids
               Specifies a list of asset IDs to delete.

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       $self->module
           Returns the module name, that is the first argument passed to
           bric_soap.

       is_allowed_param
       $pkg->is_allowed_param($param, $method)
           Returns true if $param is an allowed parameter to the $method
           method.

   Private Class Methods
       $pkg->load_asset($args)
           This method provides the meat of both create() and update().  The
           only difference between the two methods is that update_ids will be
           empty on create().

       $pkg->serialize_asset( writer        => $writer, output_channel_id  =>
       $id, args          => $args)
           Serializes a single output channel object into an <output_channel>
           using the given writer and args.

AUTHOR
       Scott Lanning <lannings@who.int>

SEE ALSO
       Bric::SOAP, Bric::SOAP::Asset



perl v5.12.2                      2005-10-07     Bric::SOAP::OutputChannel(3p)
