File Coverage

blib/lib/WWW/NOS/Open/Result.pm
Criterion Covered Total %
statement 20 20 100.0
branch n/a
condition n/a
subroutine 7 7 100.0
pod n/a
total 27 27 100.0


line stmt bran cond sub pod time code
1             package WWW::NOS::Open::Result 0.101; # -*- cperl; cperl-indent-level: 4 -*-
2 5     5   30 use strict;
  5         12  
  5         114  
3 5     5   24 use warnings;
  5         11  
  5         96  
4              
5 5     5   24 use utf8;
  5         12  
  5         22  
6 5     5   148 use 5.014000;
  5         20  
7              
8 5     5   25 use Moose qw/has/;
  5         11  
  5         38  
9 5     5   25615 use namespace::autoclean '-also' => qr/^__/sxm;
  5         24  
  5         70  
10              
11             has '_documents' => (
12             'is' => 'ro',
13             'isa' => 'ArrayRef[WWW::NOS::Open::Document]',
14             'reader' => 'get_documents',
15             'init_arg' => 'documents',
16             );
17              
18             has '_related' => (
19             'is' => 'ro',
20             'isa' => 'ArrayRef[Str]',
21             'reader' => 'get_related',
22             'init_arg' => 'related',
23             );
24              
25 5     5   624 no Moose;
  5         10  
  5         25  
26              
27             __PACKAGE__->meta->make_immutable;
28              
29             1;
30              
31             __END__
32              
33             =encoding utf8
34              
35             =for stopwords Ipenburg MERCHANTABILITY
36              
37             =head1 NAME
38              
39             WWW::NOS::Open::Result - client side search result in the Open NOS REST API.
40              
41             =head1 VERSION
42              
43             This document describes WWW::NOS::Open::Result version 0.101.
44              
45             =head1 SYNOPSIS
46              
47             use WWW::NOS::Open::Result;
48              
49             =head1 DESCRIPTION
50              
51             =head1 SUBROUTINES/METHODS
52              
53             =head2 C<new>
54              
55             Create a new result object.
56              
57             =head2 C<get_documents>
58              
59             Returns the documents found as a reference to an array of
60             L<WWW::NOS::Open::Document|WWW::NOS::Open::Document> object.
61              
62             =head2 C<get_related>
63              
64             Returns the keywords related to the performed search as a reference to an
65             array of strings.
66              
67             =head1 CONFIGURATION AND ENVIRONMENT
68              
69             =head1 DEPENDENCIES
70              
71             =over 4
72              
73             =item * L<Moose|Moose>
74              
75             =item * L<WWW::NOS::Open::Document|WWW::NOS::Open::Document>
76              
77             =item * L<namespace::autoclean|namespace::autoclean>
78              
79             =back
80              
81             =head1 INCOMPATIBILITIES
82              
83             =head1 DIAGNOSTICS
84              
85             =head1 BUGS AND LIMITATIONS
86              
87             Please report any bugs or feature requests at
88             L<RT for rt.cpan.org|https://rt.cpan.org/Dist/Display.html?Queue=WWW-NOS-Open>.
89              
90             =head1 AUTHOR
91              
92             Roland van Ipenburg, E<lt>ipenburg@xs4all.nlE<gt>
93              
94             =head1 LICENSE AND COPYRIGHT
95              
96             Copyright 2012 by Roland van Ipenburg
97              
98             This library is free software; you can redistribute it and/or modify
99             it under the same terms as Perl itself, either Perl version 5.14.0 or,
100             at your option, any later version of Perl 5 you may have available.
101              
102             =head1 DISCLAIMER OF WARRANTY
103              
104             BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
105             FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
106             OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
107             PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
108             EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
109             WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
110             ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
111             YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
112             NECESSARY SERVICING, REPAIR, OR CORRECTION.
113              
114             IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
115             WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
116             REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
117             LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
118             OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
119             THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
120             RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
121             FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
122             SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
123             SUCH DAMAGES.
124              
125             =cut