NAME
WWW::NOS::Open::Document - Class representing a client side document in the Open NOS REST API.
VERSION
This document describes WWW::NOS::Open::Document version 0.02.
SYNOPSIS
use WWW::NOS::Open::Document;DESCRIPTION
This class represents the documents that appear in the search results.
SUBROUTINES/METHODS
new
Create a new document object.
get_id
Returns the id of the document as string.
get_type
Returns the type of the document as string article, artikel, audio or video.
get_title
Returns the title of the document as string.
get_description
Returns the description of the document as string.
get_published
Returns the publishing date of the document as a DateTime object.
get_last_update
Returns the date of the last update for the document as a DateTime object.
get_thumbnail
Returns the URL of the thumbnail for the document as an URI object.
get_link
Returns the URL of the main document as an URI object.
get_keywords
Returns the list of keywords for the document as a reference to an array of strings.
get_score
Returns the score of the document as ranked in the results as a number.
CONFIGURATION AND ENVIRONMENT
DEPENDENCIES
Moose::Util::TypeConstraints Moose Readonly WWW::NOS::Open::TypeDef namespace::autoclean
INCOMPATIBILITIES
Until the API settles the resource type supports both artikel and article for an article type resource.
DIAGNOSTICS
BUGS AND LIMITATIONS
Please report any bugs or feature requests at RT for rt.cpan.org.
AUTHOR
Roland van Ipenburg <ipenburg@xs4all.nl>
LICENSE AND COPYRIGHT
Copyright 2011 by Roland van Ipenburg
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.12.2 or, at your option, any later version of Perl 5 you may have available.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.