Tim Brody > HTTP-OAI-3.28 > HTTP::OAI::ResumptionToken

Download:
HTTP-OAI-3.28.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  7
Open  1
View/Report Bugs
Source   Latest Release: HTTP-OAI-4.03

NAME ^

HTTP::OAI::ResumptionToken - Encapsulates an OAI resumption token

METHODS ^

$rt = new HTTP::OAI::ResumptionToken

This constructor method returns a new HTTP::OAI::ResumptionToken object.

$token = $rt->resumptionToken([$token])

Returns and optionally sets the resumption token string.

$ed = $rt->expirationDate([$rt])

Returns and optionally sets the expiration date of the resumption token.

$cls = $rt->completeListSize([$cls])

Returns and optionally sets the cardinality of the result set.

$cur = $rt->cursor([$cur])

Returns and optionally sets the index of the first record (of the current page) in the result set.

NOTE - Completing incomplete list ^

The final page of a record list which has been split using resumption tokens must contain an empty resumption token.

syntax highlighting: