XML::Atom::Ext::OpenSearch::Query - OpenSearch query element

XML-Atom-Ext-OpenSearch documentation Contained in the XML-Atom-Ext-OpenSearch distribution.

Index

Code Index:

NAME

Top

XML::Atom::Ext::OpenSearch::Query - OpenSearch query element

SYNOPSIS

Top

    my $query = XML::Atom::Ext:OpenSearch::Query->new;
    $query->title( 'foo' );
    $feed->add_Query( $query );

DESCRIPTION

Top

This elements represents query that was or can be performed by the client. It can be used to echo the request, or even provide an example query. Review the specification (http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_Query_element) for more information.

METHODS

Top

role( $role )

title( $title )

totalResults( $total )

searchTerms( $terms )

count( $count )

startIndex( $index )

startPage( $page )

language( $language )

outputEncoding( $encoding )

inputEncoding( $encoding )

element_name( )

Returns 'Query'.

element_ns( )

Returns the opensearch namespace, http://a9.com/-/spec/opensearch/1.1.

AUTHOR

Top

Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright 2007-2009 by Brian Cassidy

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Top

* XML::Atom::Ext::OpenSearch
XML-Atom-Ext-OpenSearch documentation Contained in the XML-Atom-Ext-OpenSearch distribution. 
package XML::Atom::Ext::OpenSearch::Query;

use strict;
use warnings;

use base qw( XML::Atom::Base );


BEGIN {
    __PACKAGE__->mk_attr_accessors(
        qw(
            role title totalResults searchTerms count startIndex
            startPage language outputEncoding inputEncoding
            )
    );
}


sub element_name {
    return 'Query';
}


sub element_ns {
    return XML::Atom::Ext::OpenSearch->element_ns;
}


1;