/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 1.0.5</a>, using an XML
 * Schema.
 * $Id$
 */

package org.oagis;

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;

/**
 * Is the schema based inheritance for all BODs. The logical model
 * would also include the DataArea.
 * 
 * @version $Revision$ $Date$
 */
public class BusinessObjectDocumentType implements java.io.Serializable {


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * OAGIS Release this BOD Instances belongs or the OAGIS
     * release that the derivative work is based on.
     */
    private java.lang.String _releaseID;

    /**
     * Indicates the version of the given BOD defintion.
     */
    private java.lang.String _versionID;

    /**
     * Indicates whether this BOD is being sent in a "Test" or a
     * "Production" mode. If the BOD is being sent in a test mode,
     * it's information should not affect the business operation.
     * However, if the BOD is sent in "Production" mode it is
     * assumed that all test has been complete and the contents of
     * the BOD are to affect the operation of the receiving
     * business application(s).
     */
    private java.lang.Object _systemEnvironmentCode = new java.lang.Object("Production");

    /**
     * Indicates the language that the contents of the BOD is in
     * unless otherwise stated.
     */
    private java.lang.Object _languageCode = new java.lang.Object("en-US");


      //----------------/
     //- Constructors -/
    //----------------/

    public BusinessObjectDocumentType() 
     {
        super();
        setSystemEnvironmentCode(new java.lang.Object("Production"));
        setLanguageCode(new java.lang.Object("en-US"));
    } //-- org.oagis.BusinessObjectDocumentType()


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Returns the value of field 'languageCode'. The field
     * 'languageCode' has the following description: Indicates the
     * language that the contents of the BOD is in unless otherwise
     * stated.
     * 
     * @return the value of field 'LanguageCode'.
     */
    public java.lang.Object getLanguageCode()
    {
        return this._languageCode;
    } //-- java.lang.Object getLanguageCode() 

    /**
     * Returns the value of field 'releaseID'. The field
     * 'releaseID' has the following description: OAGIS Release
     * this BOD Instances belongs or the OAGIS release that the
     * derivative work is based on.
     * 
     * @return the value of field 'ReleaseID'.
     */
    public java.lang.String getReleaseID()
    {
        return this._releaseID;
    } //-- java.lang.String getReleaseID() 

    /**
     * Returns the value of field 'systemEnvironmentCode'. The
     * field 'systemEnvironmentCode' has the following description:
     * Indicates whether this BOD is being sent in a "Test" or a
     * "Production" mode. If the BOD is being sent in a test mode,
     * it's information should not affect the business operation.
     * However, if the BOD is sent in "Production" mode it is
     * assumed that all test has been complete and the contents of
     * the BOD are to affect the operation of the receiving
     * business application(s).
     * 
     * @return the value of field 'SystemEnvironmentCode'.
     */
    public java.lang.Object getSystemEnvironmentCode()
    {
        return this._systemEnvironmentCode;
    } //-- java.lang.Object getSystemEnvironmentCode() 

    /**
     * Returns the value of field 'versionID'. The field
     * 'versionID' has the following description: Indicates the
     * version of the given BOD defintion.
     * 
     * @return the value of field 'VersionID'.
     */
    public java.lang.String getVersionID()
    {
        return this._versionID;
    } //-- java.lang.String getVersionID() 

    /**
     * Method isValid
     * 
     * 
     * 
     * @return true if this object is valid according to the schema
     */
    public boolean isValid()
    {
        try {
            validate();
        }
        catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    } //-- boolean isValid() 

    /**
     * 
     * 
     * @param out
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void marshal(java.io.Writer out)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, out);
    } //-- void marshal(java.io.Writer) 

    /**
     * 
     * 
     * @param handler
     * @throws java.io.IOException if an IOException occurs during
     * marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     */
    public void marshal(org.xml.sax.ContentHandler handler)
        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, handler);
    } //-- void marshal(org.xml.sax.ContentHandler) 

    /**
     * Sets the value of field 'languageCode'. The field
     * 'languageCode' has the following description: Indicates the
     * language that the contents of the BOD is in unless otherwise
     * stated.
     * 
     * @param languageCode the value of field 'languageCode'.
     */
    public void setLanguageCode(java.lang.Object languageCode)
    {
        this._languageCode = languageCode;
    } //-- void setLanguageCode(java.lang.Object) 

    /**
     * Sets the value of field 'releaseID'. The field 'releaseID'
     * has the following description: OAGIS Release this BOD
     * Instances belongs or the OAGIS release that the derivative
     * work is based on.
     * 
     * @param releaseID the value of field 'releaseID'.
     */
    public void setReleaseID(java.lang.String releaseID)
    {
        this._releaseID = releaseID;
    } //-- void setReleaseID(java.lang.String) 

    /**
     * Sets the value of field 'systemEnvironmentCode'. The field
     * 'systemEnvironmentCode' has the following description:
     * Indicates whether this BOD is being sent in a "Test" or a
     * "Production" mode. If the BOD is being sent in a test mode,
     * it's information should not affect the business operation.
     * However, if the BOD is sent in "Production" mode it is
     * assumed that all test has been complete and the contents of
     * the BOD are to affect the operation of the receiving
     * business application(s).
     * 
     * @param systemEnvironmentCode the value of field
     * 'systemEnvironmentCode'.
     */
    public void setSystemEnvironmentCode(java.lang.Object systemEnvironmentCode)
    {
        this._systemEnvironmentCode = systemEnvironmentCode;
    } //-- void setSystemEnvironmentCode(java.lang.Object) 

    /**
     * Sets the value of field 'versionID'. The field 'versionID'
     * has the following description: Indicates the version of the
     * given BOD defintion.
     * 
     * @param versionID the value of field 'versionID'.
     */
    public void setVersionID(java.lang.String versionID)
    {
        this._versionID = versionID;
    } //-- void setVersionID(java.lang.String) 

    /**
     * Method unmarshal
     * 
     * 
     * 
     * @param reader
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @return the unmarshaled org.oagis.BusinessObjectDocumentType
     */
    public static org.oagis.BusinessObjectDocumentType unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (org.oagis.BusinessObjectDocumentType) Unmarshaller.unmarshal(org.oagis.BusinessObjectDocumentType.class, reader);
    } //-- org.oagis.BusinessObjectDocumentType unmarshal(java.io.Reader) 

    /**
     * 
     * 
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void validate()
        throws org.exolab.castor.xml.ValidationException
    {
        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
        validator.validate(this);
    } //-- void validate() 

}