psdi.mbo

Interface Entity

  • All Known Implementing Classes:
    TableInfo, ViewInfo


    public interface Entity
    An interface to access persistance details of a business object without the need to figure combinations. The terminology, entity column, means the column name used by the SQL query to fetch data from database.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getAuditTable(java.lang.String tableName)
      Returns the audit table name for the given table name.
      java.lang.String getColumnName(java.lang.String entityColumnName)
      Returns the database table's 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 a given table that has the same storage as a fetch column name.
      java.util.Iterator getColumns(java.lang.String tableName)
      Returns an Iterator to iterate over the list of column names for the given table.
      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 the list of columns that are used for fetching data from database.
      java.util.Iterator getKeyColumns(java.lang.String tableName)
      Returns an Iterator to iterate over the list of key columns of the given table name.
      java.lang.String getLangColumnName(java.lang.String tableName)
      Gets the language column Name
      RowStampInfo getRowStampInfo()
      Returns rowstamp information related to this entity.
      int getTableCount()
      Returns the number of tables associted with a business object.
      java.lang.String getTableName(java.lang.String entityColumnName)
      Returns the table name for the given entity column name.
      java.util.Iterator getTables()
      Returns an Iterator to iterate over the list of tables in which the business object data is stored.
      java.util.Iterator getTablesInHierarchyOrder()
      Returns an Iterator to iterate over the list of tables in which the business object data is stored in hierarchy order of inheritance from root to leaf node.
      java.util.Iterator getTablesInReverseHierarchyOrder()
      Returns an Iterator to iterate over the list of tables in which the business object data is stored in reverse hierarchy order of inheritance from leaf node to root node.
      TenantIdInfo getTenantIdInfo()
      Returns tenantif information related to this entity.
      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 the entity has rowstamp or not.
    • Method Detail

      • getTables

        java.util.Iterator getTables()
        Returns an Iterator to iterate over the list of tables in which the business object data is stored.
      • getTableCount

        int getTableCount()
        Returns the number of tables associted with a business object.
      • getTablesInHierarchyOrder

        java.util.Iterator getTablesInHierarchyOrder()
        Returns an Iterator to iterate over the list of tables in which the business object data is stored in hierarchy order of inheritance from root to leaf node.
      • getTablesInReverseHierarchyOrder

        java.util.Iterator getTablesInReverseHierarchyOrder()
        Returns an Iterator to iterate over the list of tables in which the business object data is stored in reverse hierarchy order of inheritance from leaf node to root node.
      • getEntityColumns

        java.util.Iterator getEntityColumns()
        Returns an Iterator to iterate over the list of columns that are used for fetching data from database.
      • getColumns

        java.util.Iterator getColumns(java.lang.String tableName)
        Returns an Iterator to iterate over the list of column names for the given table. Note: If the entity is a table, the columns returned are column names of the table. If the entity is a view, the columns returned are the column names of the table on which the view is based. The column names returned by this method could be completely different from the getEntityColumns() method, if the entity is a view.
      • getTableName

        java.lang.String getTableName(java.lang.String entityColumnName)
        Returns the table name for the given entity column name.
      • getColumnName

        java.lang.String getColumnName(java.lang.String entityColumnName)
        Returns the database table's column name for the given entity column name.
      • getColumnName

        java.lang.String getColumnName(java.lang.String entityColumnName,
                                       java.lang.String tableName)
        Returns the column name for a given table that has the same storage as a fetch column name.
      • getEntityColumnName

        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.
      • getKeyColumns

        java.util.Iterator getKeyColumns(java.lang.String tableName)
        Returns an Iterator to iterate over the list of key columns of the given table name.
      • getRowStampInfo

        RowStampInfo getRowStampInfo()
        Returns rowstamp information related to this entity.
      • hasRowStamp

        boolean hasRowStamp()
        Returns whether the entity has rowstamp or not.
      • getAuditTable

        java.lang.String getAuditTable(java.lang.String tableName)
        Returns the audit table name for the given table name.
      • getLangColumnName

        java.lang.String getLangColumnName(java.lang.String tableName)
        Gets the language column Name
      • hasImplicitTenantId

        boolean hasImplicitTenantId(java.lang.String tableName)
        Returns whether the entity has tenantid or not for the table tableName.
      • hasImplicitTenantId

        boolean hasImplicitTenantId()
        Returns whether the entity has tenantid or not for any of the participating tables.
      • getTenantIdInfo

        TenantIdInfo getTenantIdInfo()
        Returns tenantif information related to this entity.