at.spardat.xma.datasource.ITabularDomData Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2003, 2007 s IT Solutions AT Spardat GmbH .
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     s IT Solutions AT Spardat GmbH - initial API and implementation
 *******************************************************************************/

// @(#) $Id: ITabularDomData.java 2089 2007-11-28 13:56:13Z s3460 $
package at.spardat.xma.datasource;

/**
 * An ITabularDomData is a special kind of tabular data, collectively known
 * under the german word Dom?ne at SPARDAT. ITabularDomDatas are
 * tables whose structure is fixed to the following columns:
 * 
 * COD_KEY. Is of type String. Identifies a row to the programmer. This column acts
 * as key. No two rows may have the same key. This column is mandatory, i.e.,
 * empty values are not allowed.
 * 
SHORT_VALUE. Of type String. Short description of the domain row for the
 * end user. This column usually holds a localized String. A cell of this
 * column may be empty. 
 * 
LONG_VALUE. Of type String. More verbose description of the domain row for
 * end user purpose. This column usually holds a localized String. A cell
 * of this column may be empty.
 * 
VALID_FROM. Of type Date. Holds the first day this row
 * is visible to the end user. Cells may be empty meaning that the visibility
 * of the row starts at negative inifinite time.
 * 
VALID_TO. Of type Date. Holds the last day this row is
 * visible to the end user. Emptyness of this columns cells means that
 * there is no time limit of visibility.
 * 
 * 
 * @author YSD, 20.06.2003 18:49:09
 */
public interface ITabularDomData extends ITabularData {

    /**
     * Returns a domain row at a provided index.
     * 
     * @param index zero based index, may range from zero up to size()-1.
     * @return the IDomRow object at the requested index.
     * @exception IllegalArgumentException if index is out of range.
     */
    public IDomRow getDomRow (int index);
    
    /**
     * Returns a row for a provided key or null
     * if there is no row with that key. All rows are searched, 
     * regardless of their valid-time-range.
     * 
     * @param key the COD_KEY of the searched row.
     * @return IDomRow object or null
     */
    public IDomRow getDomRow (String key);
}