NAME

LCC::Documents::module - Document information accessible by a Perl module

SYNOPSIS

use MyModule;
$object = MyModule->new;

use LCC;
$lcc = LCC->new( | {method => value} );

$lcc->Documents( $object, | {method => value} ); # figures out it's a module
$lcc->Documents( 'module',$object, | {method => value} ); # force module

DESCRIPTION

The Documents object of the Perl support for LCC that should be used when document information can only be accessed by method of a Perl module. Do not create directly, but through the Documents method of the LCC object.

The method is supposed to return the following elements:

1 id of a document
2 mtime of that document
3 (optional) length of that document
4 (optional) md5 of that document
5 (optional) mimetype of that document
6 (optional) subtype of that document

The method should return an empty list when there are no more documents.

By default, the method is called "next_document". If the method should have another name, then method method should be called first.

METHODS

These are the methods specific for this module. Also see the methods available in the LCC::Documents module.

method

$lcc->Documents( $object, {method => 'next'} );

Specify and/or return the name of the method that should be called on the object to obtain the information about the next document.

AUTHOR

Elizabeth Mattijsen, <liz@dijkmat.nl>.

Please report bugs to <perlbugs@dijkmat.nl>.

COPYRIGHT

Copyright (c) 2002 Elizabeth Mattijsen <liz@dijkmat.nl>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

http://lococa.sourceforge.net, the LCC.pm and the other LCC::xxx modules.