org.LexGrid.REST.commonTypes
Class Versionable

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.commonTypes.Versionable
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CodingScheme, PickListDefinition, Property, ValueDomainDefinition, VersionableAndDescribable

public class Versionable
extends LexGridBase
implements java.io.Serializable

A resource that can undergo change over time while maintaining its identity.

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

Constructor Summary
Versionable()
           
 
Method Summary
 java.util.Date getEffectiveDate()
          Returns the value of field 'effectiveDate'.
 EntryState getEntryState()
          Returns the value of field 'entryState'.
 java.util.Date getExpirationDate()
          Returns the value of field 'expirationDate'.
 java.lang.Boolean getIsActive()
          Returns the value of field 'isActive'.
 Source getOwner()
          Returns the value of field 'owner'.
 Status getStatus()
          Returns the value of field 'status'.
 java.lang.Boolean isIsActive()
          Returns the value of field 'isActive'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setEffectiveDate(java.util.Date effectiveDate)
          Sets the value of field 'effectiveDate'.
 void setEntryState(EntryState entryState)
          Sets the value of field 'entryState'.
 void setExpirationDate(java.util.Date expirationDate)
          Sets the value of field 'expirationDate'.
 void setIsActive(java.lang.Boolean isActive)
          Sets the value of field 'isActive'.
 void setOwner(Source owner)
          Sets the value of field 'owner'.
 void setStatus(Status status)
          Sets the value of field 'status'.
static Versionable unmarshalVersionable(java.io.Reader reader)
          Method unmarshalVersionable.
 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

Versionable

public Versionable()
Method Detail

getEffectiveDate

public java.util.Date getEffectiveDate()
Returns the value of field 'effectiveDate'. The field 'effectiveDate' has the following description: The date and time that this resource is considered to be active. To be considered active, isActive must be true, and the temporal context of the operation must be greater than effectiveDate. If omitted, all temporal contexts are considered to be valid.

Returns:
the value of field 'EffectiveDate'.

getEntryState

public EntryState getEntryState()
Returns the value of field 'entryState'. The field 'entryState' has the following description: A link to the revision and state change that made this what it is

Returns:
the value of field 'EntryState'.

getExpirationDate

public java.util.Date getExpirationDate()
Returns the value of field 'expirationDate'. The field 'expirationDate' has the following description: The date and time that this resource is considered to become inActive. To be considered active, isActive must be true, and the temporal context of the operation must be less than expirationDate. If omitted, all temporal contexts are considered to be valid.

Returns:
the value of field 'ExpirationDate'.

getIsActive

public java.lang.Boolean getIsActive()
Returns the value of field 'isActive'. The field 'isActive' has the following description: True means that this resource is searchable and browsable if the temporal context of the operation falls between effectiveDate and expirationDate. False means that this resource is only accessible if requested by id or by a search that specifies that inactive retrievals are allowed. Default: True

Returns:
the value of field 'IsActive'.

getOwner

public Source getOwner()
Returns the value of field 'owner'. The field 'owner' has the following description: The owner of the resource. The specific semantics of owner is defined by the busniess rules of the implementor, including the rules of the owner field is absent.

Returns:
the value of field 'Owner'.

getStatus

public Status getStatus()
Returns the value of field 'status'. The field 'status' has the following description: The status code associated with the particular resource. The semantics and business rules of entryStatus are defined by the containing system, but there needs to be a mapping into isActive above.

Returns:
the value of field 'Status'.

isIsActive

public java.lang.Boolean isIsActive()
Returns the value of field 'isActive'. The field 'isActive' has the following description: True means that this resource is searchable and browsable if the temporal context of the operation falls between effectiveDate and expirationDate. False means that this resource is only accessible if requested by id or by a search that specifies that inactive retrievals are allowed. Default: True

Returns:
the value of field 'IsActive'.

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

setEffectiveDate

public void setEffectiveDate(java.util.Date effectiveDate)
Sets the value of field 'effectiveDate'. The field 'effectiveDate' has the following description: The date and time that this resource is considered to be active. To be considered active, isActive must be true, and the temporal context of the operation must be greater than effectiveDate. If omitted, all temporal contexts are considered to be valid.

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

setEntryState

public void setEntryState(EntryState entryState)
Sets the value of field 'entryState'. The field 'entryState' has the following description: A link to the revision and state change that made this what it is

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

setExpirationDate

public void setExpirationDate(java.util.Date expirationDate)
Sets the value of field 'expirationDate'. The field 'expirationDate' has the following description: The date and time that this resource is considered to become inActive. To be considered active, isActive must be true, and the temporal context of the operation must be less than expirationDate. If omitted, all temporal contexts are considered to be valid.

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

setIsActive

public void setIsActive(java.lang.Boolean isActive)
Sets the value of field 'isActive'. The field 'isActive' has the following description: True means that this resource is searchable and browsable if the temporal context of the operation falls between effectiveDate and expirationDate. False means that this resource is only accessible if requested by id or by a search that specifies that inactive retrievals are allowed. Default: True

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

setOwner

public void setOwner(Source owner)
Sets the value of field 'owner'. The field 'owner' has the following description: The owner of the resource. The specific semantics of owner is defined by the busniess rules of the implementor, including the rules of the owner field is absent.

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

setStatus

public void setStatus(Status status)
Sets the value of field 'status'. The field 'status' has the following description: The status code associated with the particular resource. The semantics and business rules of entryStatus are defined by the containing system, but there needs to be a mapping into isActive above.

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

unmarshalVersionable

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.commonTypes.Versionable
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.