NAME
Siebel::Srvrmgr::ListParser::Output::ListComp::Comp - class that represents a Siebel component
SYNOPSIS
use Siebel::Srvrmgr::ListParser::Output::ListComp::Comp;
my $comp = Siebel::Srvrmgr::ListParser::Output::ListComp::Comp->new({ data => \%data, cc_alias => 'MyComp' });
print 'NAME = ', $comp->cc_name(), "\n";
foreach my $param(@{$comp->get_params()}) {
print $comp->get_param_val($param), "\n";
}DESCRIPTION
This class is meant to be used together with Siebel::Srvrmgr::ListParser::Output::Server since a component is always associated with a Siebel server. It make it easy to access and modify components as desired (for example, to export all components from one server to another changing some of their parameters).
ATTRIBUTES
Beware that some of the attributes of the component may reflect only the current state when the component data was recovered and are, by nature, dinamic. Some example are the number of running tasks and state of the component.
data
A hash reference with the data of the component. The expected structure of the hash reference is the same one provided by the method get_comp of the class Siebel::Srvrmgr::ListParser::Output::Server.
This is a required attribute during object creation.
cc_alias
A string of the alias of the component.
This is a required attribute during object creation.
cc_name
A string of the name of the component.
ct_alias
A string of the component type alias.
ct_name
A string of the component type name.
cg_alias
A string of the component group alias.
cc_runmode
A string of the component run mode.
cp_disp_run_state
A string of the component display run state.
This attribute is read-only.
cp_num_run_tasks
An integer with the number of running tasks of the component.
This attribute is read-only.
cp_max_tasks
An integer with the maximum number of tasks the component will execute before restart itself.
cp_actv_mts_procs
An integer wit the active MTS processes running for the component.
This attribute is read-only.
cp_max_mts_procs
An integer with the maximum number of MTS process that will run for the component.
cp_start_time
An string representing the start time of the component.
This attribute is read-only.
cp_end_time
An string representing the end time of the component.
This attribute is read-only.
cp_status
A string representing the status of the component.
This attribute is read-only.
cc_incarn_no
An integer with representing the component incarnation number.
This attribute is read-only.
cc_desc_text
A string representing the description of the component.
METHODS
All attributes have the same methods name to access them. For setting them, just invoke the method name with the desirable value as parameter.
BUILD
The BUILD method will create all attributes/methods based on the value of the data attribute.
Once this operation is finished, the data attribute is set to an empty hash reference.
get_attribs
Returns an array reference with all the parameters names associated of the component object.
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 Monitoring Tools.
Siebel Monitoring Tools 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 Monitoring Tools 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 Monitoring Tools. If not, see <http://www.gnu.org/licenses/>