Package org.faktorips.runtime

Interface ITable<R>

Type Parameters:

R - the class representing a row of this table

All Known Implementing Classes:

Table

public interface ITable<R>

Base interface for table contents

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG_NAME

Method Summary

Modifier and Type	Method	Description
List<R>	getAllRows()	Returns all rows of this table.
String	getName()	Returns the qualified name of this table.
void	setDescription(Locale locale, String newDescriptionText, IRuntimeRepository repository)	Sets or updates the description for the given Locale.
void	setDescription(org.faktorips.values.InternationalString newDescription, IRuntimeRepository repository)	Replaces the current multi-language description with the given InternationalString.
Element	toXml(Document document)	Creates an XML Element that represents this table's data.

Field Details

TAG_NAME

static final String TAG_NAME

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns the qualified name of this table.

getAllRows

List<R> getAllRows()

Returns all rows of this table.

toXml

Element toXml(Document document)

Creates an XML Element that represents this table's data.

Throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the Faktor-IPS standard builder.

Parameters:

document - a document, that can be used to create XML elements.

setDescription

void setDescription(@NonNull
 Locale locale,
 @NonNull
 String newDescriptionText,
 @NonNull
 IRuntimeRepository repository)

Sets or updates the description for the given Locale.

If the description for the locale already exists, it will be replaced. If no description exists, a new localized description entry will be added. If the table belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

Parameters:

locale - the locale for which the description is to be set (must not be null)

newDescriptionText - the new description text for the given locale (must not be null)

repository - the runtime repository containing the table (must not be null)

Throws:

NullPointerException - if either parameter is null

IllegalRepositoryModificationException - if the table is part of a read-only repository

Since:

25.7

setDescription

void setDescription(@NonNull
 org.faktorips.values.InternationalString newDescription,
 @NonNull
 IRuntimeRepository repository)

Replaces the current multi-language description with the given InternationalString.

This method will overwrite all existing localized descriptions. If the table belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

Parameters:

newDescription - the new internationalized description to set (must not be null)

repository - the runtime repository containing the table (must not be null)

Throws:

NullPointerException - if newDescription is null

IllegalRepositoryModificationException - if the table is part of a read-only repository

Since:

25.7