File Coverage

blib/lib/Siebel/Srvrmgr/Daemon/Action/Check/Component.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Siebel::Srvrmgr::Daemon::Action::Check::Component;
2              
3 4     4   582848 use Moose::Role;
  4         4608  
  4         34  
4 4     4   22827 use Siebel::Srvrmgr::Types;
  4         10  
  4         695  
5              
6             =pod
7              
8             =head1 NAME
9              
10             Siebel::Srvrmgr::Daemon::Action::Check::Component - role for classes that hold Siebel server components information
11              
12             =head1 DESCRIPTION
13              
14             This Moose Role is intended to be used by classes that provides information about which components are available in
15             a Siebel server and which is their expected status.
16              
17             =head1 ATTRIBUTES
18              
19             =head2 alias
20              
21             A string representing the alias of the component.
22              
23             =cut
24              
25             has alias => (
26             isa => 'NotNullStr',
27             is => 'ro',
28             reader => 'get_alias',
29             required => 1
30             );
31              
32             =pod
33              
34             =head2 description
35              
36             A string representing the description of the component.
37              
38             =cut
39              
40             has description =>
41             ( isa => 'Str', is => 'ro', required => 1, reader => 'get_description' );
42              
43             =pod
44              
45             =head2 componentGroup
46              
47             A string representing the Component Group alias that this component is part of.
48              
49             =cut
50              
51             has componentGroup => (
52             isa => 'NotNullStr',
53             is => 'ro',
54             required => 1,
55             reader => 'get_componentGroup',
56             );
57              
58             =pod
59              
60             =head2 OKStatus
61              
62             The status that the component is expected to have. It may be one or several (concatenated with a pipe character).
63              
64             This attribute is required during object creation.
65              
66             =cut
67              
68             has OKStatus => (
69             isa => 'NotNullStr',
70             is => 'ro',
71             reader => 'get_OKStatus',
72             required => 1
73             );
74              
75             =pod
76              
77             =head2 taskOKStatus
78              
79             The expected tasks status of the component. It may be one or several (concatenated with a pipe character).
80              
81             This attribute is required during object creation.
82              
83             =cut
84              
85             has taskOKStatus => (
86             isa => 'NotNullStr',
87             is => 'ro',
88             reader => 'get_taskOKStatus',
89             required => 1
90             );
91              
92             =pod
93              
94             =head2 criticality
95              
96             A integer indicating how critical it is if the component does not have the expected status: the largest the number,
97             the more critical it is.
98              
99             =cut
100              
101             has criticality => (
102             isa => 'Int',
103             is => 'ro',
104             reader => 'get_criticality',
105             required => 1
106             );
107              
108             =pod
109              
110             =head1 METHODS
111              
112             All attributes have their respective getter as C<get_><attribute name>.
113              
114             =head1 SEE ALSO
115              
116             =over
117              
118             =item *
119              
120             L<Siebel::Srvrmgr::Daemon::Action::Check::Server>
121              
122             =back
123              
124             =head1 AUTHOR
125              
126             Alceu Rodrigues de Freitas Junior, E<lt>arfreitas@cpan.orgE<gt>
127              
128             =head1 COPYRIGHT AND LICENSE
129              
130             This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, E<lt>arfreitas@cpan.orgE<gt>
131              
132             This file is part of Siebel Monitoring Tools.
133              
134             Siebel Monitoring Tools is free software: you can redistribute it and/or modify
135             it under the terms of the GNU General Public License as published by
136             the Free Software Foundation, either version 3 of the License, or
137             (at your option) any later version.
138              
139             Siebel Monitoring Tools is distributed in the hope that it will be useful,
140             but WITHOUT ANY WARRANTY; without even the implied warranty of
141             MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
142             GNU General Public License for more details.
143              
144             You should have received a copy of the GNU General Public License
145             along with Siebel Monitoring Tools. If not, see L<http://www.gnu.org/licenses/>.
146              
147             =cut
148              
149             1;