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

NAME

Siebel::COM::Business:Component - Perl class to represent a Siebel COM Business Component

SYNOPSIS

  sub get_bus_comp {

      my $self    = shift;
      my $bc_name = shift;

      my $bc = Siebel::COM::Business::Component->new(
          { '_ole' => $self->get_ole()->GetBusComp($bc_name) } );

      return $bc;

  }

DESCRIPTION

Siebel::COM::Business::Component is the related class to Siebel Business Component classes.

Commom usage of this class is indirect since the object is recovered from a Siebel::COM::Business::Object instance (see get_bus_comp method from it).

ATTRIBUTES

None besides the defined by the role Siebel::COM.

METHODS

The methods listed below have exactly the same interface than those of Siebel COM API for Business Components:

activate_field

Equal to ActivateField method, but also returns true if successful.

get_field_value

Equal to GetFieldValue method.

clear_query

Equal to ClearToQuery method, but also returns true if successful.

set_search_exp

Equal to SetSearchExpr method.

set_search_spec

Equalt to SetSearchSpec method, but also returns true if successful.

get_search_spec

Equal to GetSearchSpec method.

first_record

Equal to FirstRecord method.

next_record

Equal to NextRecord method.

set_field_value

Equal to SetFieldValue method, but also returns true if successful.

write_record

Equal to WriteRecord method, but also returns true if successful.

set_search_expr

Equal to SetSearchExpr method.

invoke_method

Equal to InvokeMethod method.

The following methods have some interface differences from their Siebel COM counterparts:

query

Same thing as ExecuteQuery from Siebel COM API but it defined as default FORWARD_ONLY constant for cursor mode. It accepts a different value for cursor mode although (must probably FORWARD_BACKWARD would be the choice for it).

set_view_mode

Same thing as SetViewMode from Siebel COM API but it defined as default ALL_VIEW constant for view mode. It accepts a different value for it as defined by Siebel::COM::Constants. Also, it returns true when successfully invoked.

EXPORT

None by default.

CONSTANTS

All constants from Siebel::COM::Constant are available too. This class also executes the following related functions automatically.

FORWARD_ONLY

Applies as default value for query method.

ALL_VIEW

Applies as default value for set_view_mode method.

SEE ALSO

AUTHOR

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

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 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/>.