at.spardat.xma.datasource
Interface ITabularDomData

All Superinterfaces:
ITabularData
All Known Implementing Classes:
TabularDomData

public interface ITabularDomData
extends ITabularData

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:

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.


Method Summary
 IDomRow getDomRow(int index)
          Returns a domain row at a provided index.
 IDomRow getDomRow(java.lang.String key)
          Returns a row for a provided key or null if there is no row with that key.
 
Methods inherited from interface at.spardat.xma.datasource.ITabularData
getCell, getCell, getColumnIndex, getColumnName, numCols, size
 

Method Detail

getDomRow

public IDomRow getDomRow(int index)
Returns a domain row at a provided index.

Parameters:
index - zero based index, may range from zero up to size()-1.
Returns:
the IDomRow object at the requested index.
Throws:
java.lang.IllegalArgumentException - if index is out of range.

getDomRow

public IDomRow getDomRow(java.lang.String key)
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.

Parameters:
key - the COD_KEY of the searched row.
Returns:
IDomRow object or null