com.sap.mdm.schema
Interface TableSchema

All Superinterfaces:
MetadataItem

public interface TableSchema
extends MetadataItem

This interface represents table metadata.


Method Summary
 boolean containsField(FieldId fieldId)
          Returns true if the specified field belongs to the table schema
 boolean containsField(String fieldCode)
          Returns true if the specified field belongs to the table schema
 FieldId[] getDisplayFieldIds()
          Returns the array of IDs for all display fields associated with the table.
 FieldProperties[] getDisplayFields()
          Returns the array of display fields associated with the table.
 FieldProperties getField(FieldId fieldId)
          Returns the field properties for the specified field.
 FieldProperties getField(String fieldCode)
          Returns the field properties for the specified field.
 String getFieldCode(FieldId fieldId)
          Converts the field ID to field code.
 String[] getFieldCodes()
          Returns codes for all table fields
 FieldId getFieldId(String fieldCode)
          Converts the field code to field ID.
 FieldId[] getFieldIds()
          Returns IDs for all table fields
 FieldProperties[] getFields()
          Returns properties for all fields associated with the table.
 FieldProperties[] getQualifiedFields()
          Returns the field properties for all qualified fields associated with the table.
 FieldProperties[] getQualifierFields()
          Returns the field properties for all qualifier fields associated with the table.
 ReverseLookupId[] getReverseLookups()
          Returns reverse lookups for the table schema.
 TableProperties getTable()
          Returns the table properties.
 FieldProperties[] getTaxonomyFields()
          Returns the field properties for all taxonomy fields associated with the table.
 

Method Detail

getTable

public TableProperties getTable()
Returns the table properties.

Returns:
the table properties.

getFields

public FieldProperties[] getFields()
Returns properties for all fields associated with the table.

Returns:
array of field properties.

getFieldCodes

public String[] getFieldCodes()
Returns codes for all table fields

Returns:
array of field codes

getFieldIds

public FieldId[] getFieldIds()
Returns IDs for all table fields

Returns:
array of field IDs

getFieldId

public FieldId getFieldId(String fieldCode)
                   throws IllegalArgumentException
Converts the field code to field ID.

Parameters:
fieldCode - the field code.
Returns:
field ID.
Throws:
IllegalArgumentException - if field doesn't exist in the table

getFieldCode

public String getFieldCode(FieldId fieldId)
                    throws IllegalArgumentException
Converts the field ID to field code.

Parameters:
fieldId - the field ID.
Returns:
field code.
Throws:
IllegalArgumentException - if field doesn't exist in the table

getField

public FieldProperties getField(FieldId fieldId)
                         throws IllegalArgumentException
Returns the field properties for the specified field.

Parameters:
fieldId - the field ID.
Returns:
field properties.
Throws:
IllegalArgumentException - if field doesn't exist in the table

getField

public FieldProperties getField(String fieldCode)
                         throws IllegalArgumentException
Returns the field properties for the specified field.

Parameters:
fieldCode - the field Code.
Returns:
field properties.
Throws:
IllegalArgumentException - if field doesn't exist in the table

getQualifiedFields

public FieldProperties[] getQualifiedFields()
Returns the field properties for all qualified fields associated with the table.

Returns:
array of field properties.

getQualifierFields

public FieldProperties[] getQualifierFields()
Returns the field properties for all qualifier fields associated with the table.

Returns:
array of field properties.

getTaxonomyFields

public FieldProperties[] getTaxonomyFields()
Returns the field properties for all taxonomy fields associated with the table.

Returns:
array of field properties.

getDisplayFields

public FieldProperties[] getDisplayFields()
Returns the array of display fields associated with the table.

Returns:
array of field properties.

getDisplayFieldIds

public FieldId[] getDisplayFieldIds()
Returns the array of IDs for all display fields associated with the table.

Returns:
array of field IDs.

containsField

public boolean containsField(FieldId fieldId)
Returns true if the specified field belongs to the table schema

Parameters:
fieldId - field ID
Returns:
true if the specified field belongs to the table schema, false otherwise

containsField

public boolean containsField(String fieldCode)
Returns true if the specified field belongs to the table schema

Parameters:
fieldCode - field code
Returns:
true if the specified field belongs to the table schema, false otherwise

getReverseLookups

public ReverseLookupId[] getReverseLookups()
Returns reverse lookups for the table schema.

Returns:
An array of reverse lookup IDs
Since:
7.1 SP 08


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.