com.sap.mdm.schema
Interface RepositorySchema

All Superinterfaces:
MetadataItem
All Known Subinterfaces:
RepositorySchemaEx

public interface RepositorySchema
extends MetadataItem

The RepositorySchema class holds the schema information for a repository.


Method Summary
 boolean containsTable(String tableCode)
          Returns a boolean indicating if the specified table exists.
 boolean containsTable(TableId tableId)
          Returns a boolean indicating if the specified table exists.
 boolean containsTupleDefinition(String tupleDefinitionCode)
          Returns a boolean indicating if the specified tuple definition exists.
 boolean containsTupleDefinition(TupleDefinitionId tupleDefinitionId)
          Returns a boolean indicating if the specified tuple definition exists.
 FieldProperties getField(String tableCode, String fieldCode)
          Returns properties of the specified field for the specified table
 FieldProperties getField(TableId tableId, FieldId fieldId)
          Returns properties of the specified field for the specified table
 String getFieldCode(TableId tableId, FieldId fieldId)
          Converts the field code to field ID
 String[] getFieldCodes(String tableCode)
          Returns the array of field codes for the specified table
 FieldId getFieldId(String tableCode, String fieldCode)
          Converts the field ID to field code
 FieldProperties[] getFields(String tableCode)
          Returns the properties for all fields of the specified table
 FieldProperties[] getFields(TableId tableId)
          Returns the properties for all fields of the specified table
 ImageVariantProperties getImageVariant(ImageVariantId imageVariantId)
          Returns the image variant properties for the specified image variant
 ImageVariantProperties[] getImageVariants()
          Returns the image variant properties.
 RelationshipProperties getRelationship(RelationshipId relationshipId)
          Returns the relationship properties for the specified relationship
 RelationshipProperties getRelationship(String relationshipCode)
          Returns the relationship properties for the specified relationship
 String getRelationshipCode(RelationshipId relationshipId)
          Converts the relationship ID to relationship code
 String[] getRelationshipCodes()
          Returns the relationship codes for all relationships.
 RelationshipId getRelationshipId(String relationshipCode)
          Converts the relationship code to relationship ID
 RelationshipProperties[] getRelationships()
          Returns the relationship properties.
 RemoteSystemProperties getRemoteSystem(RemoteSystemId remoteSystemId)
          Returns the remote system properties for the specified remote system
 RemoteSystemProperties getRemoteSystem(String remoteSystemCode)
          Returns the remote system properties for the specified remote system
 String getRemoteSystemCode(RemoteSystemId remoteSystemId)
          Converts the remote system ID to remote system code
 String[] getRemoteSystemCodes()
          Returns code for all remote system.
 RemoteSystemId getRemoteSystemId(String remoteSystemCode)
          Converts the remote system code to remote system ID
 RemoteSystemProperties[] getRemoteSystems()
          Returns the properties for all remote system.
 RepositoryIdentifier getRepository()
          Deprecated. use getRepositoryIdentifier
 RepositoryIdentifier getRepositoryIdentifier()
          Get repository identifier
 ReverseLookupId[] getReverseLookups(String tableCode)
          Returns reverse lookups for the table specified by its code.
 ReverseLookupId[] getReverseLookups(TableId tableId)
          Returns reverse lookups for the table specified by its ID.
 TableProperties getTable(String tableCode)
          Returns the table properties for the specified table
 TableProperties getTable(TableId tableId)
          Returns the table properties for the specified table
 String getTableCode(TableId tableId)
          Converts the table ID to table code
 String[] getTableCodes()
          Returns codes for all tables of the repository.
 TableId getTableId(String tableCode)
          Converts the table code to table ID
 TableId[] getTableIds()
          Returns IDs for all tables of the repository.
 TableSchema getTableSchema(String tableCode)
          Returns the table metadata for the specified table.
 TableSchema getTableSchema(TableId tableId)
          Returns the table metadata for the specified table.
 TupleDefinitionProperties getTupleDefinition(String tupleDefinitionCode)
          Returns the tuple definition.
 TupleDefinitionProperties getTupleDefinition(TupleDefinitionId tupleDefinitionId)
          Returns the tuple definition.
 TupleDefinitionId[] getTupleDefinitionIds()
          Returns the list of tuple definition Ids.
 TupleDefinitionSchema getTupleDefinitionSchema(String tupleDefinitionCode)
          Returns the tuple definition schema for the specified tuple definition code.
 TupleDefinitionSchema getTupleDefinitionSchema(TupleDefinitionId tupleDefinitionId)
          Returns the tuple definition schema.
 FieldProperties getTupleMemberField(String tupleDefinitionCode, String fieldCode)
          Returns the tuple member field.
 FieldProperties getTupleMemberField(TupleDefinitionId tupleDefinitionId, FieldId fieldId)
          Returns the tuple member field.
 FieldProperties[] getTupleMemberFields(String tupleDefinitionCode)
          Returns the list of tuple memeber fields.
 FieldProperties[] getTupleMemberFields(TupleDefinitionId tupleDefinitionId)
          Returns the list of tuple member fields.
 

Method Detail

getRepository

public RepositoryIdentifier getRepository()
Deprecated. use getRepositoryIdentifier

Returns repository identifier

Returns:
repository identifier

getRepositoryIdentifier

public RepositoryIdentifier getRepositoryIdentifier()
Get repository identifier

Returns:
repository identifier

getTableSchema

public TableSchema getTableSchema(TableId tableId)
                           throws IllegalArgumentException
Returns the table metadata for the specified table.

Parameters:
tableId - the table ID
Returns:
the table metadata
Throws:
IllegalArgumentException - if table doesn't exist in repository

getTableSchema

public TableSchema getTableSchema(String tableCode)
                           throws IllegalArgumentException
Returns the table metadata for the specified table.

Parameters:
tableCode - the table Code
Returns:
the table metadata
Throws:
IllegalArgumentException - if table doesn't exist in repository

getTableCodes

public String[] getTableCodes()
Returns codes for all tables of the repository.

Returns:
the array of table codes

getTableIds

public TableId[] getTableIds()
Returns IDs for all tables of the repository.

Returns:
the array of table IDs

getTable

public TableProperties getTable(TableId tableId)
                         throws IllegalArgumentException
Returns the table properties for the specified table

Parameters:
tableId - the table ID
Returns:
the table properties
Throws:
IllegalArgumentException - if table doesn't exist in repository

getTable

public TableProperties getTable(String tableCode)
                         throws IllegalArgumentException
Returns the table properties for the specified table

Parameters:
tableCode - the table Code
Returns:
the table properties
Throws:
IllegalArgumentException - if table doesn't exist in repository

containsTable

public boolean containsTable(String tableCode)
Returns a boolean indicating if the specified table exists.

Parameters:
tableCode - the table code
Returns:
True if the table exists, otherwise false
Since:
7.1 SP8

containsTable

public boolean containsTable(TableId tableId)
Returns a boolean indicating if the specified table exists.

Parameters:
tableId - the table ID
Returns:
True if the table exists, otherwise false
Since:
7.1 SP8

getTableId

public TableId getTableId(String tableCode)
                   throws IllegalArgumentException
Converts the table code to table ID

Parameters:
tableCode - the table code
Returns:
the table ID
Throws:
IllegalArgumentException - if table doesn't exist in repository

getTableCode

public String getTableCode(TableId tableId)
                    throws IllegalArgumentException
Converts the table ID to table code

Parameters:
tableId - the table ID
Returns:
the table code
Throws:
IllegalArgumentException - if table doesn't exist in repository

getFieldCodes

public String[] getFieldCodes(String tableCode)
                       throws IllegalArgumentException
Returns the array of field codes for the specified table

Parameters:
tableCode - the table code
Returns:
the array of field codes
Throws:
IllegalArgumentException - if table doesn't exist in repository

getFields

public FieldProperties[] getFields(TableId tableId)
                            throws IllegalArgumentException
Returns the properties for all fields of the specified table

Parameters:
tableId - the table ID
Returns:
the array of field properties
Throws:
IllegalArgumentException - if table doesn't exist in repository

getFields

public FieldProperties[] getFields(String tableCode)
                            throws IllegalArgumentException
Returns the properties for all fields of the specified table

Parameters:
tableCode - the table Code
Returns:
the array of field properties
Throws:
IllegalArgumentException - if table doesn't exist in repository

getField

public FieldProperties getField(TableId tableId,
                                FieldId fieldId)
                         throws IllegalArgumentException
Returns properties of the specified field for the specified table

Parameters:
tableId - the table ID
fieldId - the field ID
Returns:
the field properties
Throws:
IllegalArgumentException - if table doesn't exist in repository or field isn't a part of the table

getField

public FieldProperties getField(String tableCode,
                                String fieldCode)
                         throws IllegalArgumentException
Returns properties of the specified field for the specified table

Parameters:
tableCode - the table code name
fieldCode - the field code name
Returns:
the field properties
Throws:
IllegalArgumentException - if table doesn't exist in repository or field isn't a part of the table

getFieldId

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

Parameters:
tableCode - the table code
fieldCode - the field code
Returns:
the field ID
Throws:
IllegalArgumentException - if table doesn't exist in repository or field isn't a part of the table

getFieldCode

public String getFieldCode(TableId tableId,
                           FieldId fieldId)
                    throws IllegalArgumentException
Converts the field code to field ID

Parameters:
tableId - the table ID
fieldId - the field ID
Returns:
the field code
Throws:
IllegalArgumentException - if table doesn't exist in repository or field isn't a part of the table

getReverseLookups

public ReverseLookupId[] getReverseLookups(TableId tableId)
                                    throws IllegalArgumentException
Returns reverse lookups for the table specified by its ID.

Parameters:
tableId - the table ID
Returns:
An array of reverse lookup IDs
Throws:
IllegalArgumentException
Since:
7.1 SP 08

getReverseLookups

public ReverseLookupId[] getReverseLookups(String tableCode)
                                    throws IllegalArgumentException
Returns reverse lookups for the table specified by its code.

Parameters:
tableCode - the table code
Returns:
An array of reverse lookup IDs
Throws:
IllegalArgumentException
Since:
7.1 SP 08

getTupleDefinitionIds

public TupleDefinitionId[] getTupleDefinitionIds()
Returns the list of tuple definition Ids.

Returns:
tuple definition Ids
Since:
7.1

getTupleDefinitionSchema

public TupleDefinitionSchema getTupleDefinitionSchema(TupleDefinitionId tupleDefinitionId)
Returns the tuple definition schema.

Returns:
a tuple definition schema
Since:
7.1

getTupleDefinitionSchema

public TupleDefinitionSchema getTupleDefinitionSchema(String tupleDefinitionCode)
Returns the tuple definition schema for the specified tuple definition code.

Parameters:
tupleDefinitionCode - the tuple definition code
Returns:
The tuple definition schema
Since:
7.1 SP8

getTupleDefinition

public TupleDefinitionProperties getTupleDefinition(TupleDefinitionId tupleDefinitionId)
                                             throws IllegalArgumentException
Returns the tuple definition.

Parameters:
tupleDefinitionId - a tuple definition Id
Returns:
a tuple definition
Throws:
IllegalArgumentException
Since:
7.1

getTupleDefinition

public TupleDefinitionProperties getTupleDefinition(String tupleDefinitionCode)
                                             throws IllegalArgumentException
Returns the tuple definition.

Parameters:
tupleDefinitionCode - a tuple definition code
Returns:
a tuple definition
Throws:
IllegalArgumentException
Since:
7.1

containsTupleDefinition

public boolean containsTupleDefinition(String tupleDefinitionCode)
Returns a boolean indicating if the specified tuple definition exists.

Parameters:
tupleDefinitionCode - the tuple definition code
Returns:
True if the tuple definition exists, otherwise false
Since:
7.1 SP8

containsTupleDefinition

public boolean containsTupleDefinition(TupleDefinitionId tupleDefinitionId)
Returns a boolean indicating if the specified tuple definition exists.

Parameters:
tupleDefinitionId - the tuple definition ID
Returns:
True if the tuple definition exists, otherwise false
Since:
7.1 SP8

getTupleMemberFields

public FieldProperties[] getTupleMemberFields(TupleDefinitionId tupleDefinitionId)
                                       throws IllegalArgumentException
Returns the list of tuple member fields.

Parameters:
tupleDefinitionId - a tuple definition Id
Returns:
a list of tuple member fields
Throws:
IllegalArgumentException
Since:
7.1

getTupleMemberFields

public FieldProperties[] getTupleMemberFields(String tupleDefinitionCode)
                                       throws IllegalArgumentException
Returns the list of tuple memeber fields.

Parameters:
tupleDefinitionCode - a tuple definition code
Returns:
a list of tuple member fields
Throws:
IllegalArgumentException
Since:
7.1

getTupleMemberField

public FieldProperties getTupleMemberField(TupleDefinitionId tupleDefinitionId,
                                           FieldId fieldId)
                                    throws IllegalArgumentException
Returns the tuple member field.

Parameters:
tupleDefinitionId - a tuple definition Id
fieldId - a tuple member field Id
Returns:
a tuple member field
Throws:
IllegalArgumentException
Since:
7.1

getTupleMemberField

public FieldProperties getTupleMemberField(String tupleDefinitionCode,
                                           String fieldCode)
                                    throws IllegalArgumentException
Returns the tuple member field.

Parameters:
tupleDefinitionCode - a tuple definition code
fieldCode - a tuple member field code
Returns:
a tuple member field
Throws:
IllegalArgumentException
Since:
7.1

getRelationships

public RelationshipProperties[] getRelationships()
Returns the relationship properties.

Returns:
the array of relationship properties

getRelationshipCodes

public String[] getRelationshipCodes()
Returns the relationship codes for all relationships.

Returns:
the array of relationship codes

getRelationship

public RelationshipProperties getRelationship(RelationshipId relationshipId)
                                       throws IllegalArgumentException
Returns the relationship properties for the specified relationship

Parameters:
relationshipId - the relationship ID
Returns:
the relationship properties
Throws:
IllegalArgumentException - if relationship doesn't exist in repository

getRelationship

public RelationshipProperties getRelationship(String relationshipCode)
                                       throws IllegalArgumentException
Returns the relationship properties for the specified relationship

Parameters:
relationshipCode - the relationship Code
Returns:
the relationship properties
Throws:
IllegalArgumentException - if relationship doesn't exist in repository

getRelationshipId

public RelationshipId getRelationshipId(String relationshipCode)
                                 throws IllegalArgumentException
Converts the relationship code to relationship ID

Parameters:
relationshipCode - the relationship Code
Returns:
the relationship ID
Throws:
IllegalArgumentException - if relationship doesn't exist in repository

getRelationshipCode

public String getRelationshipCode(RelationshipId relationshipId)
                           throws IllegalArgumentException
Converts the relationship ID to relationship code

Parameters:
relationshipId - the relationship ID
Returns:
the relationship Code
Throws:
IllegalArgumentException - if relationship doesn't exist in repository

getRemoteSystems

public RemoteSystemProperties[] getRemoteSystems()
Returns the properties for all remote system.

Returns:
the array of remote system properties

getRemoteSystemCodes

public String[] getRemoteSystemCodes()
Returns code for all remote system.

Returns:
the array of remote system codes

getRemoteSystem

public RemoteSystemProperties getRemoteSystem(RemoteSystemId remoteSystemId)
                                       throws IllegalArgumentException
Returns the remote system properties for the specified remote system

Parameters:
remoteSystemId - the remote system ID
Returns:
the remote system properties
Throws:
IllegalArgumentException - if remote system doesn't exist in repository

getRemoteSystem

public RemoteSystemProperties getRemoteSystem(String remoteSystemCode)
                                       throws IllegalArgumentException
Returns the remote system properties for the specified remote system

Parameters:
remoteSystemCode - the remote system Code
Returns:
the remote system properties
Throws:
IllegalArgumentException - if remote system doesn't exist in repository

getRemoteSystemId

public RemoteSystemId getRemoteSystemId(String remoteSystemCode)
                                 throws IllegalArgumentException
Converts the remote system code to remote system ID

Parameters:
remoteSystemCode - the remote system Code
Returns:
the remote system ID
Throws:
IllegalArgumentException - if remote system doesn't exist in repository

getRemoteSystemCode

public String getRemoteSystemCode(RemoteSystemId remoteSystemId)
                           throws IllegalArgumentException
Converts the remote system ID to remote system code

Parameters:
remoteSystemId - the remote system ID
Returns:
the remote system Code
Throws:
IllegalArgumentException - if remote system doesn't exist in repository

getImageVariants

public ImageVariantProperties[] getImageVariants()
Returns the image variant properties.

Returns:
the array of image variant properties

getImageVariant

public ImageVariantProperties getImageVariant(ImageVariantId imageVariantId)
                                       throws IllegalArgumentException
Returns the image variant properties for the specified image variant

Parameters:
imageVariantId - the image variant ID
Returns:
the image variant properties
Throws:
IllegalArgumentException - if image variant doesn't exist in repository


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.