org.LexGrid.versions
Class EntryState

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.versions.EntryState
All Implemented Interfaces:
java.io.Serializable

public class EntryState
extends LexGridBase
implements java.io.Serializable

Represents a change that occurred between the current state of the versionable entry and an immediately preceeding state of the same entry.

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

Constructor Summary
EntryState()
           
 
Method Summary
 ChangeType getChangeType()
          Returns the value of field 'changeType'.
 java.lang.String getContainingRevision()
          Returns the value of field 'containingRevision'.
 java.lang.String getPrevRevision()
          Returns the value of field 'prevRevision'.
 java.lang.Long getRelativeOrder()
          Returns the value of field 'relativeOrder'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setChangeType(ChangeType changeType)
          Sets the value of field 'changeType'.
 void setContainingRevision(java.lang.String containingRevision)
          Sets the value of field 'containingRevision'.
 void setPrevRevision(java.lang.String prevRevision)
          Sets the value of field 'prevRevision'.
 void setRelativeOrder(java.lang.Long relativeOrder)
          Sets the value of field 'relativeOrder'.
static EntryState unmarshalEntryState(java.io.Reader reader)
          Method unmarshalEntryState.
 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

EntryState

public EntryState()
Method Detail

getChangeType

public ChangeType getChangeType()
Returns the value of field 'changeType'. The field 'changeType' has the following description: The type of change that occurred between this state and the previous.

Returns:
the value of field 'ChangeType'.

getContainingRevision

public java.lang.String getContainingRevision()
Returns the value of field 'containingRevision'. The field 'containingRevision' has the following description: The revision that contains this particular entry state change.

Returns:
the value of field 'ContainingRevision'.

getPrevRevision

public java.lang.String getPrevRevision()
Returns the value of field 'prevRevision'. The field 'prevRevision' has the following description: The unique identifir of the state of this entry was at prior to this change.

Returns:
the value of field 'PrevRevision'.

getRelativeOrder

public java.lang.Long getRelativeOrder()
Returns the value of field 'relativeOrder'. The field 'relativeOrder' has the following description: The relative order that this state change should be applied within the context of the containing revision.

Returns:
the value of field 'RelativeOrder'.

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

setChangeType

public void setChangeType(ChangeType changeType)
Sets the value of field 'changeType'. The field 'changeType' has the following description: The type of change that occurred between this state and the previous.

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

setContainingRevision

public void setContainingRevision(java.lang.String containingRevision)
Sets the value of field 'containingRevision'. The field 'containingRevision' has the following description: The revision that contains this particular entry state change.

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

setPrevRevision

public void setPrevRevision(java.lang.String prevRevision)
Sets the value of field 'prevRevision'. The field 'prevRevision' has the following description: The unique identifir of the state of this entry was at prior to this change.

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

setRelativeOrder

public void setRelativeOrder(java.lang.Long relativeOrder)
Sets the value of field 'relativeOrder'. The field 'relativeOrder' has the following description: The relative order that this state change should be applied within the context of the containing revision.

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

unmarshalEntryState

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.versions.EntryState
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.