The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Siebel-Srvrmgr-0.11.1
River stage zero No dependents
++
/ Siebel::Srvrmgr::ListParser::Output::Greetings

NAME

Siebel::Srvrmgr::ListParser::Output::Greetings - subclass that represents the initial information from a Siebel server when connected through srvrmgr program.

SYNOPSIS

See Siebel::Srvrmgr::ListParser::Output.

DESCRIPTION

Siebel::Srvrmgr::ListParser::Output::Greetings extends Siebel::Srvrmgr::ListParser::Output.

Normally this class would be created by Siebel::Srvrmgr::ListParser::OutputFactory create static method. See the automated tests for examples of direct instatiation.

It is possible to recover some useful information from the object methods but most of it is simple copyrigh information.

ATTRIBUTES

version

A string that represents the version of the Siebel enterprise where the connection was stablished. This is a read-only attribute.

patch

A string that represents the patch version of the Siebel enterprise where the connection was stablished. This is a read-only attribute.

An array reference that represents the copyright information of the Siebel enterprise where the connection was stablished. This is a read-only attribute.

total_servers

A integer that represents the total number of servers configured in the enterprise where the connection was stablished. This is a read-only attribute.

total_connected

A integer that represents the total number of servers available in the enterprise where the connection was stablished. This is a read-only attribute.

help

A string representing how to invoke online help within srvrmgr program. This is a read-only attribute.

field_pattern

This attribute makes no sense for Greetings class, there it will always be equal undef.

METHODS

See Siebel::Srvrmgr::ListParser::Output class for inherited methods.

get_version

Returns a string as the value of version attribute.

get_patch

Returns a string as the value of patch attribute.

Returns a string as the value of copyright attribute.

get_total_servers

Returns a integer as the value of total_servers attribute.

get_total_conn

Returns a integer as the value of total_connected attribute.

parse

This method overrides the superclass method since Siebel::Srvrmgr::ListParser::Output::Greetings simply does not follows the same sequence of parsing as the other subclasses.

Parses the data available in the raw_data attribute, setting the attribute data_parsed at the end of process.

Also the attribute raw_data has his reference changed to an empty array reference and the end of process.

_set_copyright

"Private" method to set the copyright information.

BUILD

The BUILD method sets defaults values for the attributes fields_patterns and header_cols during object creation, but those values are used only for passing tests of the API since they make no sense at all. This method should be removed in future releases of the API when the when the classes inheritance schema is changed to separate Siebel::Srvrmgr::ListParser::Output methods and attributes from the expectation of having the output in tabular configuration.

CAVEATS

Beware that the parse method is called automatically as soon as the object is created.

Greetings also does not follows the concept of fields from the superclass since it's output isn't tabular, so some related methods have "dummy" implementations since they make no sense at all to be invoked.

This is a good indicator that the superclass should be refactored to separate behaviour of output interpretation from tabular data expectation, so you might expect this interface to be changed in future releases.

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/.