> List of tutorials

Table of contents for this tutorial

Fat-Client-Development – XML-structure - Constants

* For this document and all references (links) please obey the hints and regulations concerning copyright, disclaimer and trademarks.

  • The owner of this web-site (www.javascout.biz) is not responsible for the content of web-sites linked within this document or linked within other documents of www.javascout.biz.

  • If this document or other documents of this web-site (www.javascout.biz) infringes your rights or you think that rights of others (third parties) are infringed, please inform the author.
    An e-mail can be sent by clicking onto the 'hungry mailbox' in the upper right corner.

Last revision of this document:
2006-05-05

This is document contains the code for the Constants in an 'Interface'. This Interface is used for Class JSBS_XML_Base and classes which inherit this class.
For easy 'cut and paste' ;-)

package js_base.xml;
/**
 *
 * @author kurt@javascout.biz
 * @date 2006-05-18
 *
 * @description
 * Constant values for the class JSBS_XML_Base and classes derived from it.
 * For a detailed description please see at the individual value.
 *
 * @change-log
 * when         who               why
 * --------------------------------------------------------
 *
 */
public interface JSBS_XML_Constants {
/*
 * Control-values
 * --------------
 * Control-values are introduced to control the flow of the code. */
/*
 * Values reflecting the subdirectory-names where parameters are stored. */
/*
 *
 * Status-code
 * -----------
 * Values that are returned from methods or stored in the 'StatusCode' value of the class.
 * Status-codes are introduced to signal a calling method if the construction of the class
 * or a method of the class ended error-free (CONST_OK)
 * or encountered an error - and which kind of error happened.
 */
    public static int CONST_OK = 0;
/*
 * FILE_EMPTY: Read successfull but file contains no data */
    public static int CONST_FILE_EMPTY = 1;
/*
 * NOT_WELL_FORMED: Content of the file violates XML-syntax */
    public static int CONST_NOT_WELL_FORMED = 2;
/*
 * Stati concerning <Frame> properties within the XML-structure. */
/*
 * FRAMEINDIVIDUAL_DIVISION_NOT_PRESENT:
 * There is no <FrameIndividual> division as a direct child of the root-element. */
    public static int CONST_FRAMEINDIVIDUAL_DIVISION_NOT_PRESENT = 11;
/*
 * FRAMECLASS_NOT_PRESENT:
 * A <Frame> with the searched <FrameClassName> is not present within the XML-structure. */
    public static int CONST_FRAMECLASS_NOT_PRESENT = 12;
/*
 * FRAMETITLE_NOT_PRESENT:
 * The property <FrameTitle> is not present for the searched <FrameClassName>. */
    public static int CONST_FRAMETITLE_NOT_PRESENT = 13;
/*
 * Stati concerning <Frame> properties within the XML-structure. */
/*
 * GUI_ELEMENT_NOT_PRESENT:
 * There is not even one <Element> present as a child of a <Frame>.
 * This can not be as every <Frame> has a GUI-<Element>. */
    public static int CONST_GUI_ELEMENT_NOT_PRESENT = 21;
/*
 * Stati concerning <CommonElement> properties within the XML-structure. */
/*
 * GUI_ELEMENT_COMMON_NOT_PRESENT:
 * There was a reference found to a common GUI-ELEMENT
 * but there is no such element within the XML-structure. */
    public static int CONST_GUI_ELEMENT_COMMON_NOT_PRESENT = 31;
/*
 * COMMONELEMENTS_DIVISION_NOT_PRESENT:
 * There is no <CommonElements> division as a direct child of the root-element. */
    public static int CONST_COMMONELEMENTS_DIVISION_NOT_PRESENT = 32;
/*    */
/*
 * UNKNOWN_ERROR: Something went wrong but exact reason is unknown */
    public static int CONST_UNKNOWN_ERROR = 999;
}