org.LexGrid.versions
Class EntityVersion

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.commonTypes.Describable
          extended by org.LexGrid.versions.EntityVersion
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CodingSchemeVersion

public class EntityVersion
extends Describable
implements java.io.Serializable

A static snapshot of the given entity.NOTE: This type is here for backwards compatbility with the LexBIG API, and is not otherwise used in the current LexGrid model. Do not reference or use!

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

Constructor Summary
EntityVersion()
           
 
Method Summary
 Text getChangeDocumentation()
          Returns the value of field 'changeDocumentation'.
 Text getChangeInstructions()
          Returns the value of field 'changeInstructions'.
 java.util.Date getEffectiveDate()
          Returns the value of field 'effectiveDate'.
 java.lang.Boolean getIsComplete()
          Returns the value of field 'isComplete'.
 java.lang.String getReleaseURN()
          Returns the value of field 'releaseURN'.
 java.lang.String getVersion()
          Returns the value of field 'version'.
 java.util.Date getVersionDate()
          Returns the value of field 'versionDate'.
 java.lang.Long getVersionOrder()
          Returns the value of field 'versionOrder'.
 java.lang.Boolean isIsComplete()
          Returns the value of field 'isComplete'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setChangeDocumentation(Text changeDocumentation)
          Sets the value of field 'changeDocumentation'.
 void setChangeInstructions(Text changeInstructions)
          Sets the value of field 'changeInstructions'.
 void setEffectiveDate(java.util.Date effectiveDate)
          Sets the value of field 'effectiveDate'.
 void setIsComplete(java.lang.Boolean isComplete)
          Sets the value of field 'isComplete'.
 void setReleaseURN(java.lang.String releaseURN)
          Sets the value of field 'releaseURN'.
 void setVersion(java.lang.String version)
          Sets the value of field 'version'.
 void setVersionDate(java.util.Date versionDate)
          Sets the value of field 'versionDate'.
 void setVersionOrder(java.lang.Long versionOrder)
          Sets the value of field 'versionOrder'.
static EntityVersion unmarshalEntityVersion(java.io.Reader reader)
          Method unmarshalEntityVersion.
 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

EntityVersion

public EntityVersion()
Method Detail

getChangeDocumentation

public Text getChangeDocumentation()
Returns the value of field 'changeDocumentation'. The field 'changeDocumentation' has the following description: User documentation about this particular change. Format is coding scheme specific.

Returns:
the value of field 'ChangeDocumentation'.

getChangeInstructions

public Text getChangeInstructions()
Returns the value of field 'changeInstructions'. The field 'changeInstructions' has the following description: Formal or semi-formal instructions on how to apply this change.

Returns:
the value of field 'ChangeInstructions'.

getEffectiveDate

public java.util.Date getEffectiveDate()
Returns the value of field 'effectiveDate'. The field 'effectiveDate' has the following description: The start date for which this version is operative (considered active).

Returns:
the value of field 'EffectiveDate'.

getIsComplete

public java.lang.Boolean getIsComplete()
Returns the value of field 'isComplete'. The field 'isComplete' has the following description: If true, this entity represents a complete copy of the particular release. If false, it only carries a delta.

Returns:
the value of field 'IsComplete'.

getReleaseURN

public java.lang.String getReleaseURN()
Returns the value of field 'releaseURN'. The field 'releaseURN' has the following description: URN of the release from which this version is drawn.

Returns:
the value of field 'ReleaseURN'.

getVersion

public java.lang.String getVersion()
Returns the value of field 'version'. The field 'version' has the following description: The unique version identifier.

Returns:
the value of field 'Version'.

getVersionDate

public java.util.Date getVersionDate()
Returns the value of field 'versionDate'. The field 'versionDate' has the following description: The end date for which this version is operative (considered commited).

Returns:
the value of field 'VersionDate'.

getVersionOrder

public java.lang.Long getVersionOrder()
Returns the value of field 'versionOrder'. The field 'versionOrder' has the following description: The relative order of this version within the surrounding container.

Returns:
the value of field 'VersionOrder'.

isIsComplete

public java.lang.Boolean isIsComplete()
Returns the value of field 'isComplete'. The field 'isComplete' has the following description: If true, this entity represents a complete copy of the particular release. If false, it only carries a delta.

Returns:
the value of field 'IsComplete'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class Describable
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
Overrides:
marshal in class Describable
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
Overrides:
marshal in class Describable
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

setChangeDocumentation

public void setChangeDocumentation(Text changeDocumentation)
Sets the value of field 'changeDocumentation'. The field 'changeDocumentation' has the following description: User documentation about this particular change. Format is coding scheme specific.

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

setChangeInstructions

public void setChangeInstructions(Text changeInstructions)
Sets the value of field 'changeInstructions'. The field 'changeInstructions' has the following description: Formal or semi-formal instructions on how to apply this change.

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

setEffectiveDate

public void setEffectiveDate(java.util.Date effectiveDate)
Sets the value of field 'effectiveDate'. The field 'effectiveDate' has the following description: The start date for which this version is operative (considered active).

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

setIsComplete

public void setIsComplete(java.lang.Boolean isComplete)
Sets the value of field 'isComplete'. The field 'isComplete' has the following description: If true, this entity represents a complete copy of the particular release. If false, it only carries a delta.

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

setReleaseURN

public void setReleaseURN(java.lang.String releaseURN)
Sets the value of field 'releaseURN'. The field 'releaseURN' has the following description: URN of the release from which this version is drawn.

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

setVersion

public void setVersion(java.lang.String version)
Sets the value of field 'version'. The field 'version' has the following description: The unique version identifier.

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

setVersionDate

public void setVersionDate(java.util.Date versionDate)
Sets the value of field 'versionDate'. The field 'versionDate' has the following description: The end date for which this version is operative (considered commited).

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

setVersionOrder

public void setVersionOrder(java.lang.Long versionOrder)
Sets the value of field 'versionOrder'. The field 'versionOrder' has the following description: The relative order of this version within the surrounding container.

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

unmarshalEntityVersion

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.versions.EntityVersion
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
Overrides:
validate in class Describable
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.