|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mayo.edu.lgModel.LexGridBase
org.LexGrid.REST.concepts.Comments
public class Comments
Used to select all of the comments from an entity. The URL is actually not linkable directly
Constructor Summary | |
---|---|
Comments()
|
Method Summary | |
---|---|
void |
addComment(Comment vComment)
|
void |
addComment(int index,
Comment vComment)
|
java.util.Enumeration<? extends Comment> |
enumerateComment()
Method enumerateComment. |
Comment[] |
getComment()
Method getComment.Returns the contents of the collection in an Array. |
Comment |
getComment(int index)
Method getComment. |
java.util.List<Comment> |
getCommentAsReference()
Method getCommentAsReference.Returns a reference to '_commentList'. |
int |
getCommentCount()
Method getCommentCount. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends Comment> |
iterateComment()
Method iterateComment. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllComment()
|
boolean |
removeComment(Comment vComment)
Method removeComment. |
Comment |
removeCommentAt(int index)
Method removeCommentAt. |
void |
setComment(Comment[] vCommentArray)
|
void |
setComment(int index,
Comment vComment)
|
void |
setComment(java.util.List<Comment> vCommentList)
Sets the value of '_commentList' by copying the given Vector. |
void |
setCommentAsReference(java.util.List<Comment> commentList)
Deprecated. |
static Comments |
unmarshalComments(java.io.Reader reader)
Method unmarshalComments. |
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 |
---|
public Comments()
Method Detail |
---|
public void addComment(Comment vComment) throws java.lang.IndexOutOfBoundsException
vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends Comment> enumerateComment()
public Comment getComment(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Comment[] getComment()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Comment> getCommentAsReference()
public int getCommentCount()
public boolean isValid()
public java.util.Iterator<? extends Comment> iterateComment()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
out
-
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 schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
handler
-
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 marshalingpublic void removeAllComment()
public boolean removeComment(Comment vComment)
vComment
-
public Comment removeCommentAt(int index)
index
-
public void setComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setComment(Comment[] vCommentArray)
vCommentArray
- public void setComment(java.util.List<Comment> vCommentList)
vCommentList
- the Vector to copy.public void setCommentAsReference(java.util.List<Comment> commentList)
commentList
- the Vector to set.public static Comments unmarshalComments(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
-
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 schemapublic void validate() throws org.exolab.castor.xml.ValidationException
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |