form.java

CRM源码This file describes some issues that should be implemented in future and how it should be imple

/*
 * 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.config.jxb;

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

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

import java.util.ArrayList;

/**
 * The sequence of form definition
 * 
 * @version $Revision$ $Date$
 */
public class Form extends com.queplix.core.utils.jxb.JXBObject 
implements java.io.Serializable
{


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

    /**
     * Attribute refers to entity which should be used for form
     */
    private java.lang.String _entity;

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

    /**
     * Stores info about labels position - they shall be placed
     *  either at the left or above associated controls.
     *  
     */
    private com.queplix.core.modules.config.jxb.types.FormLabelsOrientationType _labelsOrientation = com.queplix.core.modules.config.jxb.types.FormLabelsOrientationType.valueOf("horizontal");

    /**
     * Field _defaultactions
     */
    private java.lang.Boolean _defaultactions;

    /**
     * Field _tab
     */
    private java.lang.String _tab;

    /**
     * Field _order
     */
    private java.lang.Integer _order;

    /**
     * Field _caption
     */
    private java.lang.String _caption;

    /**
     * Describes possibility of represntation in the grid
     */
    private java.lang.Boolean _grid = new java.lang.Boolean("true");

    /**
     * Field _myqueweb
     */
    private java.lang.Boolean _myqueweb = new java.lang.Boolean("true");

    /**
     * Field _description
     */
    private java.lang.String _description;

    /**
     * Field _autosearch
     */
    private java.lang.Boolean _autosearch = new java.lang.Boolean("false");

    /**
     * The reference to external forms which should be loaded with
     * current form
     */
    private java.util.ArrayList _externalSetList;

    /**
     * The reference to external forms which should be used for
     * search constraints in current form
     */
    private java.util.ArrayList _externalFormList;

    /**
     * The reference to form field in another form which should be
     * initialized when current form is loaded
     */
    private java.util.ArrayList _externalFieldList;

    /**
     * Reverse to 'external-field'. The reference on the form field
     * of current form from another form. Auto-generated by system.
     */
    private java.util.ArrayList _internalFieldList;

    /**
     * The reference to linked dataset (@todo add form reference
     * instead of entity)
     */
    private java.util.ArrayList _linkedDatasetList;

    /**
     * Set of buttons which shall be added into form
     */
    private com.queplix.core.modules.config.jxb.Buttons _buttons;

    /**
     * Contains all links in the form
     */
    private com.queplix.core.modules.config.jxb.Links _links;

    /**
     * The layout for the form controls
     */
    private com.queplix.core.modules.config.jxb.Layout _layout;

    /**
     * The sequence of form's captions
     */
    private com.queplix.core.modules.config.jxb.Captions _captions;

    /**
     * The sequence of form's descriptions
     */
    private com.queplix.core.modules.config.jxb.Descriptions _descriptions;

    /**
     * Field _htmlelements
     */
    private com.queplix.core.modules.config.jxb.Htmlelements _htmlelements;


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

    public Form() 
     {
        super();
        setLabelsOrientation(com.queplix.core.modules.config.jxb.types.FormLabelsOrientationType.valueOf("horizontal"));
        _externalSetList = new ArrayList();
        _externalFormList = new ArrayList();
        _externalFieldList = new ArrayList();
        _internalFieldList = new ArrayList();
        _linkedDatasetList = new ArrayList();
    } //-- com.queplix.core.modules.config.jxb.Form()


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

    /**
     * Method addExternalField
     * 
     * 
     * 
     * @param vExternalField
     */
    public void addExternalField(com.queplix.core.modules.config.jxb.ExternalField vExternalField)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalFieldList.add(vExternalField);
    } //-- void addExternalField(com.queplix.core.modules.config.jxb.ExternalField) 

    /**
     * Method addExternalField
     * 
     * 
     * 
     * @param index
     * @param vExternalField
     */
    public void addExternalField(int index, com.queplix.core.modules.config.jxb.ExternalField vExternalField)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalFieldList.add(index, vExternalField);
    } //-- void addExternalField(int, com.queplix.core.modules.config.jxb.ExternalField) 

    /**
     * Method addExternalForm
     * 
     * 
     * 
     * @param vExternalForm
     */
    public void addExternalForm(com.queplix.core.modules.config.jxb.ExternalForm vExternalForm)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalFormList.add(vExternalForm);
    } //-- void addExternalForm(com.queplix.core.modules.config.jxb.ExternalForm) 

    /**
     * Method addExternalForm
     * 
     * 
     * 
     * @param index
     * @param vExternalForm
     */
    public void addExternalForm(int index, com.queplix.core.modules.config.jxb.ExternalForm vExternalForm)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalFormList.add(index, vExternalForm);
    } //-- void addExternalForm(int, com.queplix.core.modules.config.jxb.ExternalForm) 

    /**
     * Method addExternalSet
     * 
     * 
     * 
     * @param vExternalSet
     */
    public void addExternalSet(com.queplix.core.modules.config.jxb.ExternalSet vExternalSet)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalSetList.add(vExternalSet);
    } //-- void addExternalSet(com.queplix.core.modules.config.jxb.ExternalSet) 

    /**
     * Method addExternalSet
     * 
     * 
     * 
     * @param index
     * @param vExternalSet
     */
    public void addExternalSet(int index, com.queplix.core.modules.config.jxb.ExternalSet vExternalSet)
        throws java.lang.IndexOutOfBoundsException
    {
        _externalSetList.add(index, vExternalSet);
    } //-- void addExternalSet(int, com.queplix.core.modules.config.jxb.ExternalSet) 

    /**
     * Method addInternalField
     * 
     * 
     * 
     * @param vInternalField
     */
    public void addInternalField(com.queplix.core.modules.config.jxb.InternalField vInternalField)
        throws java.lang.IndexOutOfBoundsException
    {
        _internalFieldList.add(vInternalField);
    } //-- void addInternalField(com.queplix.core.modules.config.jxb.InternalField) 

    /**
     * Method addInternalField
     * 
     * 
     * 
     * @param index
     * @param vInternalField
     */
    public void addInternalField(int index, com.queplix.core.modules.config.jxb.InternalField vInternalField)
        throws java.lang.IndexOutOfBoundsException
    {
        _internalFieldList.add(index, vInternalField);
    } //-- void addInternalField(int, com.queplix.core.modules.config.jxb.InternalField) 

    /**
     * Method addLinkedDataset
     * 
     * 
     * 
     * @param vLinkedDataset
     */
    public void addLinkedDataset(com.queplix.core.modules.config.jxb.LinkedDataset vLinkedDataset)
        throws java.lang.IndexOutOfBoundsException
    {
        _linkedDatasetList.add(vLinkedDataset);
    } //-- void addLinkedDataset(com.queplix.core.modules.config.jxb.LinkedDataset) 

    /**
     * Method addLinkedDataset
     * 
     * 
     * 
     * @param index
     * @param vLinkedDataset
     */
    public void addLinkedDataset(int index, com.queplix.core.modules.config.jxb.LinkedDataset vLinkedDataset)
        throws java.lang.IndexOutOfBoundsException
    {
        _linkedDatasetList.add(index, vLinkedDataset);
    } //-- void addLinkedDataset(int, com.queplix.core.modules.config.jxb.LinkedDataset) 

    /**
     * Method clearExternalField
     * 
     */
    public void clearExternalField()
    {
        _externalFieldList.clear();
    } //-- void clearExternalField() 

    /**
     * Method clearExternalForm
     * 
     */
    public void clearExternalForm()
    {
        _externalFormList.clear();
    } //-- void clearExternalForm() 

    /**
     * Method clearExternalSet
     * 
     */
    public void clearExternalSet()
    {
        _externalSetList.clear();
    } //-- void clearExternalSet() 

    /**
     * Method clearInternalField
     * 
     */
    public void clearInternalField()
    {
        _internalFieldList.clear();
    } //-- void clearInternalField() 

    /**
     * Method clearLinkedDataset
     * 
     */
    public void clearLinkedDataset()
    {
        _linkedDatasetList.clear();
    } //-- void clearLinkedDataset() 

    /**
     * Method enumerateExternalField
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateExternalField()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_externalFieldList.iterator());
    } //-- java.util.Enumeration enumerateExternalField() 

    /**
     * Method enumerateExternalForm
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateExternalForm()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_externalFormList.iterator());
    } //-- java.util.Enumeration enumerateExternalForm() 

    /**
     * Method enumerateExternalSet
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateExternalSet()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_externalSetList.iterator());
    } //-- java.util.Enumeration enumerateExternalSet() 

    /**
     * Method enumerateInternalField
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateInternalField()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_internalFieldList.iterator());
    } //-- java.util.Enumeration enumerateInternalField() 

    /**
     * Method enumerateLinkedDataset
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateLinkedDataset()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_linkedDatasetList.iterator());
    } //-- java.util.Enumeration enumerateLinkedDataset() 

    /**
     * Returns the value of field 'autosearch'.
     * 
     * @return Boolean
     * @return the value of field 'autosearch'.
     */
    public java.lang.Boolean getAutosearch()
    {
        return this._autosearch;
    } //-- java.lang.Boolean getAutosearch() 

    /**
     * Returns the value of field 'buttons'. The field 'buttons'
     * has the following description: Set of buttons which shall be
     * added into form
     * 
     * @return Buttons
     * @return the value of field 'buttons'.
     */
    public com.queplix.core.modules.config.jxb.Buttons getButtons()
    {
        return this._buttons;
    } //-- com.queplix.core.modules.config.jxb.Buttons getButtons() 

    /**
     * Returns the value of field 'caption'.
     * 
     * @return String
     * @return the value of field 'caption'.
     */
    public java.lang.String getCaption()
    {
        return this._caption;
    } //-- java.lang.String getCaption() 

    /**
     * Returns the value of field 'captions'. The field 'captions'
     * has the following description: The sequence of form's
     * captions
     * 
     * @return Captions
     * @return the value of field 'captions'.