eu.dnetlib.data.information.oai.publisher.info

Interface ResumptionToken

All Known Implementing Classes:

ResumptionTokenImpl

public interface ResumptionToken

Method Summary

Modifier and Type	Method and Description
void	deserialize(String token) Deserializes the resumption token and sets the properties of this token accordingly.
String	getLastObjIdentifier() Gets the identifier of the last returned document.
String	getMetadataPrefix() Gets the requested metadata prefix.
int	getnMaxElements() Gets the total number of documents.
int	getnRead() Gets the number of already read records.
String	getQuery() Gets the requested query.
String	getRequestedSet() Gets the requested set.
boolean	hasDateRange()
String	serialize() Serializes the resumption token.
void	setDateRange(boolean hasDateRange)
void	setLastObjIdentifier(String lastObjIdentifier) Sets the identifier of the last returned document.
void	setMetadataPrefix(String metadataPrefix) Sets the requested metadata prefix.
void	setnMaxElements(int nMaxElements) Sets the total number of documents.
void	setnRead(int nRead) Sets the number of already read records.
void	setQuery(String query) Sets the requested query.
void	setRequestedSet(String requestedSet) Sets the requested set.

Method Detail

serialize

String serialize()

Serializes the resumption token.

Returns:

a String serialization of this token.

deserialize

void deserialize(String token)
          throws BadResumptionTokenException

Deserializes the resumption token and sets the properties of this token accordingly.

Parameters:

token - a String serialization of this token.

Throws:

BadResumptionTokenException - if the token is not compliant to the expected format and therefore cannot be serialized

getnMaxElements

int getnMaxElements()

Gets the total number of documents.

Returns:

the total number of documents

setnMaxElements

void setnMaxElements(int nMaxElements)

Sets the total number of documents.

Parameters:

nMaxElements - the total number of documents

getMetadataPrefix

String getMetadataPrefix()

Gets the requested metadata prefix.

Returns:

the metadata prefix

setMetadataPrefix

void setMetadataPrefix(String metadataPrefix)

Sets the requested metadata prefix.

Parameters:

metadataPrefix -

getQuery

String getQuery()

Gets the requested query.

Returns:

the requested query

setQuery

void setQuery(String query)

Sets the requested query.

Parameters:

query - the requested query

getnRead

int getnRead()

Gets the number of already read records.

Returns:

the number of already read records.

setnRead

void setnRead(int nRead)

Sets the number of already read records.

Parameters:

nRead - the number of already read records.

getLastObjIdentifier

String getLastObjIdentifier()

Gets the identifier of the last returned document.

Returns:

the identifier of the last returned document

setLastObjIdentifier

void setLastObjIdentifier(String lastObjIdentifier)

Sets the identifier of the last returned document.

Parameters:

lastObjIdentifier - the identifier of the last returned document

getRequestedSet

String getRequestedSet()

Gets the requested set.

Returns:

the requested set

setRequestedSet

void setRequestedSet(String requestedSet)

Sets the requested set.

Parameters:

requestedSet - the name of the requested set

hasDateRange

boolean hasDateRange()

Returns:

true if the OAI request associated to this ResumptionToken has a date range.

setDateRange

void setDateRange(boolean hasDateRange)