Base-Class for a Set of Business Objects - Fat-Client-Development

This is document contains the code for Class JSBS_BO_Set.
For easy 'cut and paste' ;-)

For an overview of the idea of Business Objects please refer to Using Business Objects to handle data-storage and -retrieval .

package js_base.bo;

import java.util.Vector;

import js_base.bo.JSBS_BO;

/**
 *
 * @author kurt@javascout.biz
 * @date 2007-01-11
 *
 * @description
 *  Base-Class for Sets of Business Objects.
 *  This class can be inherited by Business Objects holding a set of Business Objects.
 *
 * @change-log
 * when         who               why
 * --------------------------------------------------------
 *
 */
public class JSBS_BO_Set {
/*
 * Vector holding the set of Business Objects.
 * This variable does not define the type of the vector content;
 * The conversion of the content to Business Objects has to be done in the
 * classes inheriting this base-class. */
    public Vector vecRecordSet = new Vector();
/*
 * Constant with the column name for the row-numbering (1 .. x);
 * valid for all 'vectors' containing raw-data for display.
 * This constant is also used as 'ElementName' to get the language-
 * dependant text for the Jtable-header out of the file 'DisplayStrings.xml'. */
    public static final String CONST_ColumnName_RowNr = "Row-Number";
/*
 * Vector holding the formatted data that can be used to be displayed in a
 * JTable without further formatting.
 * Vector with index 0 holds a vector containing the symbolic column names;
 * the following vectors hold the data in a sequence coincident with
 * the symbolic column names.
 * The vector has to be filled by classes inheriting this class. */
    public Vector vecRawDisplayData = new Vector();
/*
 * Status code to signal results (see interface JSBS_BO_Constants)
 * of methods to the caller. */
    public int StatusCode = JSBS_BO.CONST_DB_UNKNOWN_ERROR;
/*
 * Status message; additional information for a returned StatusCode –
 * e.g. the error reported by the database-system together with a database-error. */
    public String StatusMsg = "";
}