TableUsage (org.faktorips.runtime 21.6.0-SNAPSHOT API)

java.lang.Object
- org.faktorips.runtime.model.type.ModelElement
- - org.faktorips.runtime.model.type.TypePart
  - - org.faktorips.runtime.model.type.TableUsage

```
public class TableUsage
extends TypePart
```
Describes the model information for a table usage.

Constructor Summary

Constructors
Constructor Description

TableUsage(Type parent, java.lang.reflect.Method getterMethod)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ITable<?>`	`getTable(IProductComponent productComponent, java.util.Calendar effectiveDate)`	Returns the table the given product component references for this table usage.
`TableStructure`	`getTableStructure()`
`java.lang.String`	`toString()`

Methods inherited from class org.faktorips.runtime.model.type.TypePart
getMessageHelper, getMessageKey, getModelType, getType, getTypeName

Methods inherited from class org.faktorips.runtime.model.type.ModelElement
createMessageHelper, getDescription, getDocumentation, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, invokeField, invokeMethod

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TableUsage
```
public TableUsage(Type parent,
                  java.lang.reflect.Method getterMethod)
```
- Method Detail
  - getTable
```
public ITable<?> getTable(IProductComponent productComponent,
                          java.util.Calendar effectiveDate)
```
    Returns the table the given product component references for this table usage. If this table usage is changing over time (resides in the generation) the date is used to retrieve the correct generation. If the date is null the latest generation is used. If the table usage is not changing over time the date will be ignored.
    
    Parameters:
    
    productComponent - The product component that holds the table instance
    
    effectiveDate - the date to determine the product component generation. If null the latest generation is used. Is ignored if the table usage configuration is not changing over time.
    
    Returns:
    
    The table instance hold by the product component and is identified by this table usage
  - getTableStructure
```
public TableStructure getTableStructure()
```
    Returns:
    
    the model for the table structure referenced in this table usage.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this table usage uses multiple table structures.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class ModelElement