|
|||||||||
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.commonTypes.Describable
org.LexGrid.REST.versions.Revision
public class Revision
An ordered collection of state changes that define the transformation of a set of resources from one consistent state to another.
Constructor Summary | |
---|---|
Revision()
|
Method Summary | |
---|---|
void |
addChangeAgent(int index,
Source vChangeAgent)
|
void |
addChangeAgent(Source vChangeAgent)
|
void |
addChangedEntry(ChangedEntry vChangedEntry)
|
void |
addChangedEntry(int index,
ChangedEntry vChangedEntry)
|
java.util.Enumeration<? extends Source> |
enumerateChangeAgent()
Method enumerateChangeAgent. |
java.util.Enumeration<? extends ChangedEntry> |
enumerateChangedEntry()
Method enumerateChangedEntry. |
Source[] |
getChangeAgent()
Method getChangeAgent.Returns the contents of the collection in an Array. |
Source |
getChangeAgent(int index)
Method getChangeAgent. |
java.util.List<Source> |
getChangeAgentAsReference()
Method getChangeAgentAsReference.Returns a reference to '_changeAgentList'. |
int |
getChangeAgentCount()
Method getChangeAgentCount. |
ChangedEntry[] |
getChangedEntry()
Method getChangedEntry.Returns the contents of the collection in an Array. |
ChangedEntry |
getChangedEntry(int index)
Method getChangedEntry. |
java.util.List<ChangedEntry> |
getChangedEntryAsReference()
Method getChangedEntryAsReference.Returns a reference to '_changedEntryList'. |
int |
getChangedEntryCount()
Method getChangedEntryCount. |
Text |
getChangeInstructions()
Returns the value of field 'changeInstructions'. |
java.lang.Long |
getEditOrder()
Returns the value of field 'editOrder'. |
java.util.Date |
getRevisionDate()
Returns the value of field 'revisionDate'. |
RevisionId |
getRevisionId()
Returns the value of field 'revisionId'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends Source> |
iterateChangeAgent()
Method iterateChangeAgent. |
java.util.Iterator<? extends ChangedEntry> |
iterateChangedEntry()
Method iterateChangedEntry. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllChangeAgent()
|
void |
removeAllChangedEntry()
|
boolean |
removeChangeAgent(Source vChangeAgent)
Method removeChangeAgent. |
Source |
removeChangeAgentAt(int index)
Method removeChangeAgentAt. |
boolean |
removeChangedEntry(ChangedEntry vChangedEntry)
Method removeChangedEntry. |
ChangedEntry |
removeChangedEntryAt(int index)
Method removeChangedEntryAt. |
void |
setChangeAgent(int index,
Source vChangeAgent)
|
void |
setChangeAgent(java.util.List<Source> vChangeAgentList)
Sets the value of '_changeAgentList' by copying the given Vector. |
void |
setChangeAgent(Source[] vChangeAgentArray)
|
void |
setChangeAgentAsReference(java.util.List<Source> changeAgentList)
Deprecated. |
void |
setChangedEntry(ChangedEntry[] vChangedEntryArray)
|
void |
setChangedEntry(int index,
ChangedEntry vChangedEntry)
|
void |
setChangedEntry(java.util.List<ChangedEntry> vChangedEntryList)
Sets the value of '_changedEntryList' by copying the given Vector. |
void |
setChangedEntryAsReference(java.util.List<ChangedEntry> changedEntryList)
Deprecated. |
void |
setChangeInstructions(Text changeInstructions)
Sets the value of field 'changeInstructions'. |
void |
setEditOrder(java.lang.Long editOrder)
Sets the value of field 'editOrder'. |
void |
setRevisionDate(java.util.Date revisionDate)
Sets the value of field 'revisionDate'. |
void |
setRevisionId(RevisionId revisionId)
Sets the value of field 'revisionId'. |
static Revision |
unmarshalRevision(java.io.Reader reader)
Method unmarshalRevision. |
void |
validate()
|
Methods inherited from class org.LexGrid.commonTypes.Describable |
---|
getEntityDescription, setEntityDescription, unmarshalDescribable |
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 Revision()
Method Detail |
---|
public void addChangeAgent(Source vChangeAgent) throws java.lang.IndexOutOfBoundsException
vChangeAgent
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addChangeAgent(int index, Source vChangeAgent) throws java.lang.IndexOutOfBoundsException
index
- vChangeAgent
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addChangedEntry(ChangedEntry vChangedEntry) throws java.lang.IndexOutOfBoundsException
vChangedEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addChangedEntry(int index, ChangedEntry vChangedEntry) throws java.lang.IndexOutOfBoundsException
index
- vChangedEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends Source> enumerateChangeAgent()
public java.util.Enumeration<? extends ChangedEntry> enumerateChangedEntry()
public Source getChangeAgent(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Source[] getChangeAgent()
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<Source> getChangeAgentAsReference()
public int getChangeAgentCount()
public Text getChangeInstructions()
public ChangedEntry getChangedEntry(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic ChangedEntry[] getChangedEntry()
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<ChangedEntry> getChangedEntryAsReference()
public int getChangedEntryCount()
public java.lang.Long getEditOrder()
public java.util.Date getRevisionDate()
public RevisionId getRevisionId()
public boolean isValid()
isValid
in class Describable
public java.util.Iterator<? extends Source> iterateChangeAgent()
public java.util.Iterator<? extends ChangedEntry> iterateChangedEntry()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class Describable
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
marshal
in class Describable
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 removeAllChangeAgent()
public void removeAllChangedEntry()
public boolean removeChangeAgent(Source vChangeAgent)
vChangeAgent
-
public Source removeChangeAgentAt(int index)
index
-
public boolean removeChangedEntry(ChangedEntry vChangedEntry)
vChangedEntry
-
public ChangedEntry removeChangedEntryAt(int index)
index
-
public void setChangeAgent(int index, Source vChangeAgent) throws java.lang.IndexOutOfBoundsException
index
- vChangeAgent
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setChangeAgent(Source[] vChangeAgentArray)
vChangeAgentArray
- public void setChangeAgent(java.util.List<Source> vChangeAgentList)
vChangeAgentList
- the Vector to copy.public void setChangeAgentAsReference(java.util.List<Source> changeAgentList)
changeAgentList
- the Vector to set.public void setChangeInstructions(Text changeInstructions)
changeInstructions
- the value of field
'changeInstructions'.public void setChangedEntry(int index, ChangedEntry vChangedEntry) throws java.lang.IndexOutOfBoundsException
index
- vChangedEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setChangedEntry(ChangedEntry[] vChangedEntryArray)
vChangedEntryArray
- public void setChangedEntry(java.util.List<ChangedEntry> vChangedEntryList)
vChangedEntryList
- the Vector to copy.public void setChangedEntryAsReference(java.util.List<ChangedEntry> changedEntryList)
changedEntryList
- the Vector to set.public void setEditOrder(java.lang.Long editOrder)
editOrder
- the value of field 'editOrder'.public void setRevisionDate(java.util.Date revisionDate)
revisionDate
- the value of field 'revisionDate'.public void setRevisionId(RevisionId revisionId)
revisionId
- the value of field 'revisionId'.public static Revision unmarshalRevision(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
validate
in class Describable
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 |