com.sap.mdm.schema
Interface TupleDefinitionSchema

All Superinterfaces:
MetadataItem

public interface TupleDefinitionSchema
extends MetadataItem

This interface represents tuple definition metadata.

Since:
7.1

Method Summary
 boolean containsField(FieldId fieldId)
          Returns true if the specified field belongs to the tuple definition schema
 boolean containsField(String fieldCode)
          Returns true if the specified field belongs to the tuple definition schema
 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 tuple definition fields
 FieldId getFieldId(String fieldCode)
          Converts the field code to field ID.
 FieldId[] getFieldIds()
          Returns IDs for all tuple definition fields
 FieldProperties[] getFields()
          Returns properties for all fields associated with the tuple definition.
 TupleDefinitionProperties getTupleDefinition()
          Returns the tuple definition properties.
 

Method Detail

getTupleDefinition

public TupleDefinitionProperties getTupleDefinition()
Returns the tuple definition properties.

Returns:
the tuple definition properties.

getFields

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

Returns:
array of field properties.

getFieldCodes

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

Returns:
array of field codes

getFieldIds

public FieldId[] getFieldIds()
Returns IDs for all tuple definition 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 tuple definition

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 tuple definition

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 tuple definition

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 tuple definition

containsField

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

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

containsField

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

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


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.