org.LexGrid.REST.commonTypes
Class Continuation

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.commonTypes.Continuation
All Implemented Interfaces:
java.io.Serializable

public class Continuation
extends LexGridBase
implements java.io.Serializable

A continuation record - associated with REST directory type entries. When a directory is requested, the "maxToReturn" parameter can be set to "-1", which means unlimited, a positive integer which means return, no more than "n" and "0" which means optimize it as you see

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Continuation()
           
 
Method Summary
 java.lang.Boolean getIsComplete()
          Returns the value of field 'isComplete'.
 java.lang.Boolean getIsMore()
          Returns the value of field 'isMore'.
 Resource getNext()
          Returns the value of field 'next'.
 java.lang.Long getNumEntries()
          Returns the value of field 'numEntries'.
 Resource getPrev()
          Returns the value of field 'prev'.
 java.lang.Boolean isIsComplete()
          Returns the value of field 'isComplete'.
 java.lang.Boolean isIsMore()
          Returns the value of field 'isMore'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setIsComplete(java.lang.Boolean isComplete)
          Sets the value of field 'isComplete'.
 void setIsMore(java.lang.Boolean isMore)
          Sets the value of field 'isMore'.
 void setNext(Resource next)
          Sets the value of field 'next'.
 void setNumEntries(java.lang.Long numEntries)
          Sets the value of field 'numEntries'.
 void setPrev(Resource prev)
          Sets the value of field 'prev'.
static Continuation unmarshalContinuation(java.io.Reader reader)
          Method unmarshalContinuation.
 void validate()
           
 
Methods inherited from class org.mayo.edu.lgModel.LexGridBase
getParent, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Continuation

public Continuation()
Method Detail

getIsComplete

public java.lang.Boolean getIsComplete()
Returns the value of field 'isComplete'. The field 'isComplete' has the following description: True means that this directory contains all of the entries for the requested resource, false means that some are not prexent

Returns:
the value of field 'IsComplete'.

getIsMore

public java.lang.Boolean getIsMore()
Returns the value of field 'isMore'. The field 'isMore' has the following description: True means that there are more to come , false means you've seen it all.

Returns:
the value of field 'IsMore'.

getNext

public Resource getNext()
Returns the value of field 'next'. The field 'next' has the following description: If more entries exist in a directory structure, this contains a link to the next block of records

Returns:
the value of field 'Next'.

getNumEntries

public java.lang.Long getNumEntries()
Returns the value of field 'numEntries'. The field 'numEntries' has the following description: The number of entries returned in this block

Returns:
the value of field 'NumEntries'.

getPrev

public Resource getPrev()
Returns the value of field 'prev'. The field 'prev' has the following description: If a preceeding block of entries exist, this contains that link

Returns:
the value of field 'Prev'.

isIsComplete

public java.lang.Boolean isIsComplete()
Returns the value of field 'isComplete'. The field 'isComplete' has the following description: True means that this directory contains all of the entries for the requested resource, false means that some are not prexent

Returns:
the value of field 'IsComplete'.

isIsMore

public java.lang.Boolean isIsMore()
Returns the value of field 'isMore'. The field 'isMore' has the following description: True means that there are more to come , false means you've seen it all.

Returns:
the value of field 'IsMore'.

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setIsComplete

public void setIsComplete(java.lang.Boolean isComplete)
Sets the value of field 'isComplete'. The field 'isComplete' has the following description: True means that this directory contains all of the entries for the requested resource, false means that some are not prexent

Parameters:
isComplete - the value of field 'isComplete'.

setIsMore

public void setIsMore(java.lang.Boolean isMore)
Sets the value of field 'isMore'. The field 'isMore' has the following description: True means that there are more to come , false means you've seen it all.

Parameters:
isMore - the value of field 'isMore'.

setNext

public void setNext(Resource next)
Sets the value of field 'next'. The field 'next' has the following description: If more entries exist in a directory structure, this contains a link to the next block of records

Parameters:
next - the value of field 'next'.

setNumEntries

public void setNumEntries(java.lang.Long numEntries)
Sets the value of field 'numEntries'. The field 'numEntries' has the following description: The number of entries returned in this block

Parameters:
numEntries - the value of field 'numEntries'.

setPrev

public void setPrev(Resource prev)
Sets the value of field 'prev'. The field 'prev' has the following description: If a preceeding block of entries exist, this contains that link

Parameters:
prev - the value of field 'prev'.

unmarshalContinuation

public static Continuation unmarshalContinuation(java.io.Reader reader)
                                          throws org.exolab.castor.xml.MarshalException,
                                                 org.exolab.castor.xml.ValidationException
Method unmarshalContinuation.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.commonTypes.Continuation
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.