eu.etaxonomy.cdm.remote.dto.oaipmh
Class ResumptionToken

java.lang.Object
  eu.etaxonomy.cdm.remote.dto.oaipmh.ResumptionToken

All Implemented Interfaces:

Serializable

public class ResumptionToken
extends Object
implements Serializable

A resumptionToken may have 3 optional attributes and can be used in ListSets, ListIdentifiers, ListRecords responses.

Java class for resumptionTokenType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="resumptionTokenType">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>string">
       <attribute name="expirationDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="completeListSize" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" />
       <attribute name="cursor" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
     </extension>
   </simpleContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected BigInteger	completeListSize
protected BigInteger	cursor
protected org.joda.time.DateTime	expirationDate
protected String	value

Constructor Summary

ResumptionToken()

ResumptionToken(Pager results, org.joda.time.DateTime from, org.joda.time.DateTime until, MetadataPrefix metadataPrefix, SetSpec set)

Method Summary

static ResumptionToken	emptyResumptionToken()
BigInteger	getCompleteListSize() Gets the value of the completeListSize property.
BigInteger	getCursor() Gets the value of the cursor property.
org.joda.time.DateTime	getExpirationDate() Gets the value of the expirationDate property.
org.joda.time.DateTime	getFrom()
MetadataPrefix	getMetadataPrefix()
SetSpec	getSet()
org.joda.time.DateTime	getUntil()
String	getValue() Gets the value of the value property.
void	setCompleteListSize(BigInteger value) Sets the value of the completeListSize property.
void	setCursor(BigInteger value) Sets the value of the cursor property.
void	setExpirationDate(org.joda.time.DateTime value) Sets the value of the expirationDate property.
void	setValue(String value) Sets the value of the value property.
void	updateResults(Pager results)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected String value

expirationDate

protected org.joda.time.DateTime expirationDate

completeListSize

protected BigInteger completeListSize

cursor

protected BigInteger cursor

Constructor Detail

ResumptionToken

public ResumptionToken(Pager results,
                       org.joda.time.DateTime from,
                       org.joda.time.DateTime until,
                       MetadataPrefix metadataPrefix,
                       SetSpec set)

ResumptionToken

public ResumptionToken()

Method Detail

getValue

public String getValue()

Gets the value of the value property.

Returns:

possible object is String

setValue

public void setValue(String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

getExpirationDate

public org.joda.time.DateTime getExpirationDate()

Gets the value of the expirationDate property.

Returns:

possible object is XMLGregorianCalendar

setExpirationDate

public void setExpirationDate(org.joda.time.DateTime value)

Sets the value of the expirationDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getCompleteListSize

public BigInteger getCompleteListSize()

Gets the value of the completeListSize property.

Returns:

possible object is BigInteger

setCompleteListSize

public void setCompleteListSize(BigInteger value)

Sets the value of the completeListSize property.

Parameters:

value - allowed object is BigInteger

getCursor

public BigInteger getCursor()

Gets the value of the cursor property.

Returns:

possible object is BigInteger

setCursor

public void setCursor(BigInteger value)

Sets the value of the cursor property.

Parameters:

value - allowed object is BigInteger

getMetadataPrefix

public MetadataPrefix getMetadataPrefix()

getFrom

public org.joda.time.DateTime getFrom()

getUntil

public org.joda.time.DateTime getUntil()

getSet

public SetSpec getSet()

updateResults

public void updateResults(Pager results)

emptyResumptionToken

public static ResumptionToken emptyResumptionToken()