TableInfo (Maximo API)

java.lang.Object
- psdi.util.CachedObjectPointer
- - psdi.mbo.TableInfo

All Implemented Interfaces:

java.io.Serializable, Entity
```
public class TableInfo
extends CachedObjectPointer
implements Entity
```
A class to represent information about MAXIMO table used by a business object. The table information is obtained from the maxtable table.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CACHE_NAME`
`static int`	`MT_DELTA_TABLE`
`static int`	`MT_DELTA2_TABLE`
`static int`	`MT_LANDLORDONLY_TABLE`
`static int`	`MT_SYSTEM_TABLE`
`static int`	`MT_TEMPLATE_TABLE`
`static int`	`MT_TEMPLATE2_TABLE`
`static int`	`MT_TENANT_TABLE`

Fields inherited from class psdi.util.CachedObjectPointer
coRef, ref

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumnInfo(TableColumnInfo columnInfo)` Adds column information to this table information.
`void`	`addMLInUseColumn()` Increase the number of multi-language in use columns of this table.
`java.lang.String`	`getAltIxName()` Get the alternate index name of this table.
`java.lang.String`	`getAuditTable(java.lang.String tableName)` Returns audit table associated with this table, if any.
`java.lang.String`	`getCacheName()`
`TableColumnInfo`	`getColumnInfo(java.lang.String columnName)` Returns column information in a TableColumnInfo object for the given column name, if the column name exists for this table, otherwise returns null.
`java.lang.String`	`getColumnName(java.lang.String entityColumnName)` Returns the column name for the given entity column name.
`java.lang.String`	`getColumnName(java.lang.String entityColumnName, java.lang.String tableName)` Returns the column name for the given entity column name and table name.
`java.util.Iterator`	`getColumns()` Returns an Iterator to iterate over columns of this table.
`java.util.Iterator`	`getColumns(java.lang.String tableName)` Returns an Iterator to iterate over columns of this table.
`java.lang.String`	`getContentAttrName()` Get the content attribute name for this table.
`java.lang.String`	`getEAuditTableName()` Returns the audit table name in which the audit record information is written.
`java.lang.String`	`getEntityColumnName(java.lang.String tableColumnName, java.lang.String tableName)` Returns the entity column name for the given table column name and table name.
`java.util.Iterator`	`getEntityColumns()` Returns an Iterator to iterate over columns of this table.
`java.lang.String`	`getExtTableName()` Returns the name of the table.
`java.util.Iterator`	`getKeyColumns()` Returns an Iterator to iterate over key column names.
`java.util.Iterator`	`getKeyColumns(java.lang.String tableName)` Returns an Iterator to iterate over key column names.
`java.lang.String`	`getLangColumnName()` Returns the Unique Column name for which sequence is created
`java.lang.String`	`getLangColumnName(java.lang.String tableName)` Returns the Language Column name This method is provided to support the Entity interface.
`java.lang.String`	`getLangTBName()` Get the language table name of this table.
`java.lang.String`	`getMLParent()`
`RowStampInfo`	`getRowStampInfo()` Returns rowstamp information for this table, if rowstamp column exists.
`int`	`getStorageType()`
`int`	`getTableCount()` Returns the number of tables associated with this object.
`java.lang.String`	`getTableName()` Returns the name of the table.
`java.lang.String`	`getTableName(java.lang.String entityColumnName)` Returns the table name for the given column name.
`java.util.Iterator`	`getTables()` Returns an Iterator to iterate over table name.
`java.util.Iterator`	`getTablesInHierarchyOrder()` Returns an Iterator to iterate over table name.
`java.util.Iterator`	`getTablesInReverseHierarchyOrder()` Returns an Iterator to iterate over table name in reverse hierarchy order.
`TenantIdInfo`	`getTenantIdInfo()` Returns tenantif information related to this entity.
`TableInfoBase`	`getTypedReference()`
`TableInfoBase`	`getTypedReferenceForSet()`
`java.lang.String`	`getUniqueColumnName()` Get the unqiue column name of this table.
`boolean`	`hasImplicitTenantId()` Returns whether the entity has tenantid or not for any of the participating tables.
`boolean`	`hasImplicitTenantId(java.lang.String tableName)` Returns whether the entity has tenantid or not for the table `tableName`.
`boolean`	`hasRowStamp()` Returns whether rowstamp information exists for this table or not.
`boolean`	`isMLInUse()` Whether the table's multi-language support is being used
`boolean`	`isRowStampColumnExists()` Returns whether rowstamp column exists for this table or not.
`boolean`	`isTenantOwned()`
`boolean`	`isTextSearchEnabled()` returns whether this table is text search enabled or not
`boolean`	`isUsedForAuditing()` Returns whether this table is used for auditing.
`boolean`	`isUsedForMLang()` Return whether the table is the language table for multi-lang support
`void`	`removeMLInUseColumn()` Decrease the number of multi-language in use columns of this table.

Methods inherited from class psdi.util.CachedObjectPointer
getClonedInfo, getID, getParent, getReference, getReferenceForSet, isSameTenantAsReference, setID, setParent, setReference, setTenantReference

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

- Field Detail
  - CACHE_NAME
```
public static final java.lang.String CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - MT_TENANT_TABLE
```
public static final int MT_TENANT_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_DELTA_TABLE
```
public static final int MT_DELTA_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_SYSTEM_TABLE
```
public static final int MT_SYSTEM_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_TEMPLATE_TABLE
```
public static final int MT_TEMPLATE_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_LANDLORDONLY_TABLE
```
public static final int MT_LANDLORDONLY_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_TEMPLATE2_TABLE
```
public static final int MT_TEMPLATE2_TABLE
```
    See Also:
    
    Constant Field Values
  - MT_DELTA2_TABLE
```
public static final int MT_DELTA2_TABLE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getEAuditTableName
```
public java.lang.String getEAuditTableName()
```
    Returns the audit table name in which the audit record information is written.
    
    Returns:
    
    audit table name.
  - isUsedForAuditing
```
public boolean isUsedForAuditing()
```
    Returns whether this table is used for auditing.
    
    Returns:
    
    true, if this table is used for auditing, otherwise false.
  - isUsedForMLang
```
public boolean isUsedForMLang()
```
    Return whether the table is the language table for multi-lang support
    
    Returns:
  - isRowStampColumnExists
```
public boolean isRowStampColumnExists()
```
    Returns whether rowstamp column exists for this table or not.
    
    Returns:
    
    true, if rowstamp column exists for this table, otherwise false.
  - getTableName
```
public java.lang.String getTableName()
```
    Returns the name of the table.
    
    Returns:
    
    the name of the table.
  - getExtTableName
```
public java.lang.String getExtTableName()
```
    Returns the name of the table.
    
    Returns:
    
    the name of the table.
  - isTextSearchEnabled
```
public boolean isTextSearchEnabled()
```
    returns whether this table is text search enabled or not
    
    Returns:
    
    true if table is text search enabled else false.
  - getTables
```
public java.util.Iterator getTables()
```
    Returns an Iterator to iterate over table name. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.
    
    Specified by:
    
    getTables in interface Entity
    
    Returns:
    
    an Iterator to iterate over table name.
    
    See Also:
    
    Entity.getTables()
  - getTableCount
```
public int getTableCount()
```
    Returns the number of tables associated with this object. This method is provided to support the Entity interface. Always returns 1.
    
    Specified by:
    
    getTableCount in interface Entity
    
    Returns:
    
    the number of tables, always returns 1.
    
    See Also:
    
    Entity.getTableCount()
  - getTablesInHierarchyOrder
```
public java.util.Iterator getTablesInHierarchyOrder()
```
    Returns an Iterator to iterate over table name. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.
    
    Specified by:
    
    getTablesInHierarchyOrder in interface Entity
    
    Returns:
    
    an Iterator to iterate over table name.
    
    See Also:
    
    Entity.getTablesInHierarchyOrder()
  - getTablesInReverseHierarchyOrder
```
public java.util.Iterator getTablesInReverseHierarchyOrder()
```
    Returns an Iterator to iterate over table name in reverse hierarchy order. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.
    
    Specified by:
    
    getTablesInReverseHierarchyOrder in interface Entity
    
    Returns:
    
    an Iterator to iterate over table name.
    
    See Also:
    
    Entity.getTablesInReverseHierarchyOrder()
  - getTableName
```
public java.lang.String getTableName(java.lang.String entityColumnName)
```
    Returns the table name for the given column name. Always returns the name of this table. This method is provided to support the Entity interface.
    
    Specified by:
    
    getTableName in interface Entity
    
    Parameters:
    
    entityColumnName - column name
    
    Returns:
    
    table name
    
    See Also:
    
    Entity.getTableName(java.lang.String)
  - getColumnName
```
public java.lang.String getColumnName(java.lang.String entityColumnName)
```
    Returns the column name for the given entity column name. Always returns the entity column name passed. This method is provided to support the Entity interface.
    
    Specified by:
    
    getColumnName in interface Entity
    
    Parameters:
    
    entityColumnName - column name
    
    Returns:
    
    column name
    
    See Also:
    
    Entity.getColumnName(java.lang.String)
  - getColumnName
```
public java.lang.String getColumnName(java.lang.String entityColumnName,
                                      java.lang.String tableName)
```
    Returns the column name for the given entity column name and table name. Always returns the entity column name passed. This method is provided to support the Entity interface.
    
    Specified by:
    
    getColumnName in interface Entity
    
    Parameters:
    
    entityColumnName - entity column name
    
    tableName - table name
    
    Returns:
    
    column name
    
    See Also:
    
    Entity.getColumnName(java.lang.String, java.lang.String)
  - getEntityColumnName
```
public java.lang.String getEntityColumnName(java.lang.String tableColumnName,
                                            java.lang.String tableName)
```
    Returns the entity column name for the given table column name and table name. Always returns the table column name passed. This method is provided to support the Entity interface.
    
    Specified by:
    
    getEntityColumnName in interface Entity
    
    Parameters:
    
    tableColumnName - table column name
    
    tableName - table name
    
    Returns:
    
    entity column name
    
    See Also:
    
    Entity.getEntityColumnName(java.lang.String, java.lang.String)
  - getRowStampInfo
```
public RowStampInfo getRowStampInfo()
```
    Returns rowstamp information for this table, if rowstamp column exists. This method is provided to support the Entity interface.
    
    Specified by:
    
    getRowStampInfo in interface Entity
    
    Returns:
    
    rowstamp information in RowStampInfo object, if rowstamp column exists, otherwise returns null.
    
    See Also:
    
    Entity.getRowStampInfo()
  - getTenantIdInfo
```
public TenantIdInfo getTenantIdInfo()
```
    Description copied from interface: Entity
    
    Returns tenantif information related to this entity.
    
    Specified by:
    
    getTenantIdInfo in interface Entity
  - hasRowStamp
```
public boolean hasRowStamp()
```
    Returns whether rowstamp information exists for this table or not. This method is provided to support the Entity interface.
    
    Specified by:
    
    hasRowStamp in interface Entity
    
    Returns:
    
    true, if rowstamp information exists, otherwise false.
    
    See Also:
    
    Entity.hasRowStamp()
  - getAuditTable
```
public java.lang.String getAuditTable(java.lang.String tableName)
```
    Returns audit table associated with this table, if any.
    
    Specified by:
    
    getAuditTable in interface Entity
    
    Returns:
    
    audit table associated with this table, if any, otherwise returns null.
    
    See Also:
    
    Entity.getAuditTable(java.lang.String)
  - getLangTBName
```
public java.lang.String getLangTBName()
```
    Get the language table name of this table. If there is no language table associated with this table either the multi-lang support is never being used or not enabled at all, this method will return null.
    
    Returns:
  - addMLInUseColumn
```
public void addMLInUseColumn()
```
    Increase the number of multi-language in use columns of this table.
  - removeMLInUseColumn
```
public void removeMLInUseColumn()
```
    Decrease the number of multi-language in use columns of this table.
  - isMLInUse
```
public boolean isMLInUse()
```
    Whether the table's multi-language support is being used
  - getUniqueColumnName
```
public java.lang.String getUniqueColumnName()
```
    Get the unqiue column name of this table.
    
    Returns:
    
    the unique column name.
  - getContentAttrName
```
public java.lang.String getContentAttrName()
```
    Get the content attribute name for this table.
    
    Returns:
    
    the content attribute name.
  - getAltIxName
```
public java.lang.String getAltIxName()
```
    Get the alternate index name of this table.
    
    Returns:
    
    The alternate index name.
  - getLangColumnName
```
public java.lang.String getLangColumnName()
```
    Returns the Unique Column name for which sequence is created
    
    Returns:
    
    Unique Column name.
  - getLangColumnName
```
public java.lang.String getLangColumnName(java.lang.String tableName)
```
    Returns the Language Column name This method is provided to support the Entity interface.
    
    Specified by:
    
    getLangColumnName in interface Entity
    
    Returns:
    
    langauge Column name.
  - getStorageType
```
public int getStorageType()
```
    Returns:
    
    the storage type for the table.
  - getMLParent
```
public java.lang.String getMLParent()
```
    Returns:
    
    the parent table for the multi langauge table
  - hasImplicitTenantId
```
public boolean hasImplicitTenantId(java.lang.String tableName)
```
    Description copied from interface: Entity
    
    Returns whether the entity has tenantid or not for the table tableName.
    
    Specified by:
    
    hasImplicitTenantId in interface Entity
  - hasImplicitTenantId
```
public boolean hasImplicitTenantId()
```
    Description copied from interface: Entity
    
    Returns whether the entity has tenantid or not for any of the participating tables.
    
    Specified by:
    
    hasImplicitTenantId in interface Entity
  - addColumnInfo
```
public void addColumnInfo(TableColumnInfo columnInfo)
```
    Adds column information to this table information.
    
    Parameters:
    
    columnInfo - column information to be added.
  - getColumnInfo
```
public TableColumnInfo getColumnInfo(java.lang.String columnName)
```
    Returns column information in a TableColumnInfo object for the given column name, if the column name exists for this table, otherwise returns null.
    
    Parameters:
    
    columnName - name of the column for which additional information is needed.
    
    Returns:
    
    TableColumnInfo object if the column name exists for this table, otherwise null.
  - getKeyColumns
```
public java.util.Iterator getKeyColumns()
```
    Returns an Iterator to iterate over key column names. The iterator objects are of type String.
    
    Returns:
    
    an Iterator to iterate over key column names.
  - getColumns
```
public java.util.Iterator getColumns()
```
    Returns an Iterator to iterate over columns of this table. The iterator objects are of type String. The order in which the columns names are returned is not always gauranteed to be same.
    
    Returns:
    
    an Iterator to iterate over columns of this table.
  - getEntityColumns
```
public java.util.Iterator getEntityColumns()
```
    Returns an Iterator to iterate over columns of this table. The iterator objects are of type String. This method is provided to support the Entity interface. The order in which the columns names are returned is not always gauranteed to be same.
    
    Specified by:
    
    getEntityColumns in interface Entity
    
    Returns:
    
    an Iterator to iterate over columns of this table.
    
    See Also:
    
    Entity.getEntityColumns()
  - getColumns
```
public java.util.Iterator getColumns(java.lang.String tableName)
```
    Returns an Iterator to iterate over columns of this table. The iterator objects are of type String. This method is provided to support the Entity interface. The order in which the columns names are returned is not always gauranteed to be same.
    
    Specified by:
    
    getColumns in interface Entity
    
    Returns:
    
    an Iterator to iterate over columns of this table.
    
    See Also:
    
    Entity.getColumns(java.lang.String)
  - getKeyColumns
```
public java.util.Iterator getKeyColumns(java.lang.String tableName)
```
    Returns an Iterator to iterate over key column names. The iterator objects are of type String. This method is provided to support the Entity interface.
    
    Specified by:
    
    getKeyColumns in interface Entity
    
    Returns:
    
    an Iterator to iterate over key column names.
    
    See Also:
    
    Entity.getKeyColumns(java.lang.String)
  - getTypedReference
```
public TableInfoBase getTypedReference()
```
  - getTypedReferenceForSet
```
public TableInfoBase getTypedReferenceForSet()
```
  - isTenantOwned
```
public boolean isTenantOwned()
```
  - getCacheName
```
public java.lang.String getCacheName()
```
    Overrides:
    
    getCacheName in class CachedObjectPointer

Fields inherited from class psdi.util.CachedObjectPointer

Methods inherited from class psdi.util.CachedObjectPointer

Methods inherited from class java.lang.Object

CACHE_NAME

MT_TENANT_TABLE

MT_DELTA_TABLE

MT_SYSTEM_TABLE

MT_TEMPLATE_TABLE

MT_LANDLORDONLY_TABLE

MT_TEMPLATE2_TABLE

MT_DELTA2_TABLE

getEAuditTableName

isUsedForAuditing

isUsedForMLang

isRowStampColumnExists

getTableName

getExtTableName

isTextSearchEnabled

getTables

getTableCount

getTablesInHierarchyOrder

getTablesInReverseHierarchyOrder

getTableName

getColumnName

getColumnName

getEntityColumnName

getRowStampInfo

getTenantIdInfo

hasRowStamp

getAuditTable

getLangTBName

addMLInUseColumn

removeMLInUseColumn

isMLInUse

getUniqueColumnName

getContentAttrName

getAltIxName

getLangColumnName

getLangColumnName

getStorageType

getMLParent

hasImplicitTenantId

hasImplicitTenantId

addColumnInfo

getColumnInfo

getKeyColumns

getColumns

getEntityColumns

getColumns

getKeyColumns

getTypedReference

getTypedReferenceForSet

isTenantOwned

getCacheName