Bric::SOAP::User(3p)  User Contributed Perl Documentation Bric::SOAP::User(3p)



NAME
       Bric::SOAP::User - SOAP interface to Bricolage users

VERSION
       $LastChangedRevision$

DATE
       $LastChangedDate: 2004-09-14 02:48:55 +0200 (Tue, 14 Sep 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 User module
         $soap->uri('http://bricolage.sourceforge.net/Bric/SOAP/User');

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

DESCRIPTION
       This module provides a SOAP interface to manipulating Bricolage users.

INTERFACE
   Public Class Methods
       list_ids
           This method queries the database for matching users and returns a
           list of ids.  If no users 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).

           prefix (M)
               The user's prefix.

           lname (M)
               The user's last name.

           fname (M)
               The user's first name.

           mname (M)
               The user's middle name.

           suffix (M)
               The user's suffix.

           login (M)
               The user's login.

           active
               Set false to return deleted users.

           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:

           user_id
               Specifies a single user_id to be retrieved.

           user_ids
               Specifies a list of user_ids.  The value for this option should
               be an array of integer "user_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 "user_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:

           user_id
               Specifies a single asset ID to be deleted.

           user_ids
               Specifies a list of asset IDs to delete.

           Throws:

           Exception::AP

           Side Effects: updates the last-modified user time in the cache so
           that the UI reloads the users (unless you're a deleted user :).

           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, user_id  => $id, args
       => $args)
           Serializes a single user object into a <user> user using the given
           writer and args.

AUTHOR
       Scott Lanning <lannings@who.int>

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



perl v5.12.2                      2004-09-13              Bric::SOAP::User(3p)
