NAME

InfoSys::FreeDB::Response::LsCat - FreeDB lscat response

SYNOPSIS

 require InfoSys::FreeDB;
 
 # Create a HTTP connection
 my $fact = InfoSys::FreeDB->new();
 my $conn = $fact->create_connection( {
     client_name => 'testing-InfoSys::FreeDB',
     client_version => $InfoSys::FreeDB::VERSION,
 } );
 
 # Get lscat from FreeDB
 my $res = $conn->lscat();
 
 # Write the categories to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 foreach my $cat ( $res->get_category() ) {
     $fh->print( "$cat\n" );
 }

ABSTRACT

FreeDB lscat response

DESCRIPTION

InfoSys::FreeDB::Response::LsCat contains information about FreeDB lscat responses.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new InfoSys::FreeDB::Response::LsCat object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

category

Passed to set_category(). Must be an ARRAY reference.

Options for OPT_HASH_REF inherited through package InfoSys::FreeDB::Response may include:

code

Passed to set_code(). Mandatory option.

error

Passed to set_error().

result

Passed to set_result(). Mandatory option.

new_from_content_ref(CONTENT_REF)

Creates a new InfoSys::FreeDB::Response::LsCat object from the specified content reference. CONTENT_REF is a string reference. On error an exception Error::Simple is thrown.

METHODS

exists_category(ARRAY)

Returns the count of items in ARRAY that are in the category list.

get_category( [ INDEX_ARRAY ] )

Returns an ARRAY containing the category list. INDEX_ARRAY is an optional list of indexes which when specified causes only the indexed elements in the ordered list to be returned. If not specified, all elements are returned.

get_code()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.

get_result()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.

is_error()

This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.

pop_category()

Pop and return an element off the category list. On error an exception Error::Simple is thrown.

push_category(ARRAY)

Push additional values on the category list. ARRAY is the list value. On error an exception Error::Simple is thrown.

set_category(ARRAY)

Set the category list absolutely. ARRAY is the list value. On error an exception Error::Simple is thrown.

set_code(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. Set the response code. VALUE is the value. On error an exception Error::Simple is thrown.

set_error(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. State that the response has an error. VALUE is the value. On error an exception Error::Simple is thrown.

set_idx_category( INDEX, VALUE )

Set value in the category list. INDEX is the integer index which is greater than or equal to 0. VALUE is the value.

set_num_category( NUMBER, VALUE )

Set value in the category list. NUMBER is the integer index which is greater than 0. VALUE is the value.

set_result(VALUE)

This method is inherited from package InfoSys::FreeDB::Response. Set the response result text. VALUE is the value. On error an exception Error::Simple is thrown.

shift_category()

Shift and return an element off the category list. On error an exception Error::Simple is thrown.

unshift_category(ARRAY)

Unshift additional values on the category list. ARRAY is the list value. On error an exception Error::Simple is thrown.

SEE ALSO

the InfoSys::FreeDB manpage, the InfoSys::FreeDB::Connection manpage, the InfoSys::FreeDB::Connection::CDDBP manpage, the InfoSys::FreeDB::Connection::HTTP manpage, the InfoSys::FreeDB::Entry manpage, the InfoSys::FreeDB::Entry::Track manpage, the InfoSys::FreeDB::Match manpage, the InfoSys::FreeDB::Response manpage, the InfoSys::FreeDB::Response::DiscId manpage, the InfoSys::FreeDB::Response::Hello manpage, the InfoSys::FreeDB::Response::Motd manpage, the InfoSys::FreeDB::Response::Proto manpage, the InfoSys::FreeDB::Response::Query manpage, the InfoSys::FreeDB::Response::Quit manpage, the InfoSys::FreeDB::Response::Read manpage, the InfoSys::FreeDB::Response::SignOn manpage, the InfoSys::FreeDB::Response::Sites manpage, the InfoSys::FreeDB::Response::Stat manpage, the InfoSys::FreeDB::Response::Ver manpage, the InfoSys::FreeDB::Response::Whom manpage, the InfoSys::FreeDB::Response::Write::1 manpage, the InfoSys::FreeDB::Response::Write::2 manpage, the InfoSys::FreeDB::Site manpage

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: December 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the InfoSys::FreeDB module hierarchy for Perl by Vincenzo Zocca.

The InfoSys::FreeDB module hierarchy 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 2 of the License, or (at your option) any later version.

The InfoSys::FreeDB module hierarchy 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 the InfoSys::FreeDB module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA