The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Siebel-COM-0.2
River stage zero No dependents
++
/ Siebel::COM::App

NAME

Siebel::COM::App - Perl extension to connect to a Siebel application

SYNOPSIS

  package Siebel::COM::App::DataServer;

  use Moose;
  use namespace::autoclean;

  extends 'Siebel::COM::App';

DESCRIPTION

Siebel::COM::App is a superclass and cannot be used directly: a subclass is required since it does not provide any connection at all to a Siebel environment.

As a superclass, Siebel::COM::App provides:

  • proper initialization of subclasses, including default exceptions from Win32::OLE.

  • the attributes described in the section ATTRIBUTES.

  • the methods described in the section METHODS.

EXPORT

None by default.

ATTRIBUTES

All attributes below are required during object creation.

user

The user login that will be used for authentication when login method is invoked.

password

The user password that will be used for authentication when login method is invoked.

ole_class

The class that should be loaded by Win32::OLE. Beware that the class must be registered correctly to be used.

METHODS

BUILD

Moose based BUILD method takes care of initializing correctly subclasses of Siebel::COM::App, including changing the warnings from Win32::OLE to force exceptions by executing Win32::OLE-Option( Warn => 3 )>.

login

Login does, uhn, login at a Siebel application. It expects does not expect any parameter and returns true with success or an exception is raised.

get_bus_object

Returns a Siebel::COM::Business::Object object (or a subclass of it): expects a Business Object name as a parameter and an exception is raised if the Business Object definition cannot be found in the SRF.

get_last_error

Returns the last error message retrieved, including the error message code and message.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org<>

This file is part of Siebel COM project.

Siebel COM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Siebel COM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Siebel COM. If not, see <http://www.gnu.org/licenses/>.