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

package com.queplix.core.modules.alert.jxb;

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

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

/**
 * Class ParamType.
 *
 * @version $Revision$ $Date$
 */
public class ParamType extends com.queplix.core.utils.jxb.JXBObject
        implements java.io.Serializable {

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

    /**
     * The name of parameter
     */
    private java.lang.String _name;

    /**
     * The type of parameter
     */
    private com.queplix.core.modules.alert.jxb.types.ParamTypeSType _type = com
            .queplix.core.modules.alert.jxb.types.ParamTypeSType.valueOf(
            "string");

    /**
     * Describes what parameter is required
     */
    private java.lang.Boolean _required = new java.lang.Boolean("true");

    /**
     * The value of parameter
     */
    private java.lang.String _value;

    /**
     * The description of this parameter
     */
    private java.lang.String _description;

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

    public ParamType() {
        super();
        setType(com.queplix.core.modules.alert.jxb.types.ParamTypeSType.valueOf(
                "string"));
    } //-- com.queplix.core.modules.alert.jxb.ParamType()

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

    /**
     * Returns the value of field 'description'. The field
     * 'description' has the following description: The description
     * of this parameter
     *
     * @return the value of field 'description'.
     */
    public java.lang.String getDescription() {
        return this._description;
    } //-- java.lang.String getDescription() 

    /**
     * Returns the value of field 'name'. The field 'name' has the
     * following description: The name of parameter
     *
     * @return the value of field 'name'.
     */
    public java.lang.String getName() {
        return this._name;
    } //-- java.lang.String getName() 

    /**
     * Returns the value of field 'required'. The field 'required'
     * has the following description: Describes what parameter is
     * required
     *
     * @return the value of field 'required'.
     */
    public java.lang.Boolean getRequired() {
        return this._required;
    } //-- java.lang.Boolean getRequired() 

    /**
     * Returns the value of field 'type'. The field 'type' has the
     * following description: The type of parameter
     *
     * @return the value of field 'type'.
     */
    public com.queplix.core.modules.alert.jxb.types.ParamTypeSType getType() {
        return this._type;
    } //-- com.queplix.core.modules.alert.jxb.types.ParamTypeSType getType() 

    /**
     * Returns the value of field 'value'. The field 'value' has
     * the following description: The value of parameter
     *
     * @return the value of field 'value'.
     */
    public java.lang.String getValue() {
        return this._value;
    } //-- java.lang.String getValue() 

    /**
     * Method isValid
     *
     * @return boolean
     */
    public boolean isValid() {
        try {
            validate();
        }
        catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    } //-- boolean isValid() 

    /**
     * Method marshal
     *
     * @param out
     */
    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) 

    /**
     * Method marshal
     *
     * @param handler
     */
    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 'description'. The field
     * 'description' has the following description: The description
     * of this parameter
     *
     * @param description the value of field 'description'.
     */
    public void setDescription(java.lang.String description) {
        this._description = description;
    } //-- void setDescription(java.lang.String) 

    /**
     * Sets the value of field 'name'. The field 'name' has the
     * following description: The name of parameter
     *
     * @param name the value of field 'name'.
     */
    public void setName(java.lang.String name) {
        this._name = name;
    } //-- void setName(java.lang.String) 

    /**
     * Sets the value of field 'required'. The field 'required' has
     * the following description: Describes what parameter is
     * required
     *
     * @param required the value of field 'required'.
     */
    public void setRequired(java.lang.Boolean required) {
        this._required = required;
    } //-- void setRequired(java.lang.Boolean) 

    /**
     * Sets the value of field 'type'. The field 'type' has the
     * following description: The type of parameter
     *
     * @param type the value of field 'type'.
     */
    public void setType(
            com.queplix.core.modules.alert.jxb.types.ParamTypeSType type) {
        this._type = type;
    } //-- void setType(com.queplix.core.modules.alert.jxb.types.ParamTypeSType) 

    /**
     * Sets the value of field 'value'. The field 'value' has the
     * following description: The value of parameter
     *
     * @param value the value of field 'value'.
     */
    public void setValue(java.lang.String value) {
        this._value = value;
    } //-- void setValue(java.lang.String) 

    /**
     * Method unmarshal
     *
     * @param reader
     * @return Object
     */
    public static java.lang.Object unmarshal(java.io.Reader reader)
            throws org.exolab.castor.xml.MarshalException,
            org.exolab.castor.xml.ValidationException {
        return (com.queplix.core.modules.alert.jxb.ParamType) Unmarshaller
                .unmarshal(com.queplix.core.modules.alert.jxb.ParamType.class,
                        reader);
    } //-- java.lang.Object unmarshal(java.io.Reader) 

    /**
     * Method validate
     */
    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() 

}
