com.sap.mdm.extension.schema
Interface RepositorySchemaEx

All Superinterfaces:
MetadataItem, RepositorySchema

public interface RepositorySchemaEx
extends RepositorySchema

This interface represents the schema information of repository.


Method Summary
 PortProperties getPort(PortId portId)
          Returns the port properties for the specified port
 PortProperties getPort(String portCode, String remoteSystemCode, int portType)
          Returns the port properties for the specified port
 String getPortCode(PortId portId)
          Converts the port ID to port code
 PortId getPortId(String portCode, String remoteSystemCode, int portType)
          Converts the port code to port ID
 PortProperties[] getPorts()
          Returns the properties for all ports.
 RegionProperties getRegion(Locale locale)
          Returns region corresponded to the specified Locale
 RegionProperties getRegion(String regionNameOrCode)
          Returns region corresponded to the specified region name
 RepositoryProperties getRepositoryProperties()
          Returns repository properties
 RegionInheritanceProperties getRepositoryRegionInheritance(String regionCode)
          Returns the region inheritance of the repository for specified region.
 RoleProperties getRole(String roleName)
          Returns the role properties for the specified role name
 String[] getRoleNames()
          Returns the array of role names.
 RoleProperties[] getRoles()
          Returns the properties for all roles.
 UserProperties getUser(String userName)
          Returns the user properties for the specified user name
 String[] getUserNames()
          Returns the array of user names.
 UserProperties[] getUsers()
          Returns the properties for all users.
 
Methods inherited from interface com.sap.mdm.schema.RepositorySchema
containsTable, containsTable, containsTupleDefinition, containsTupleDefinition, getField, getField, getFieldCode, getFieldCodes, getFieldId, getFields, getFields, getImageVariant, getImageVariants, getRelationship, getRelationship, getRelationshipCode, getRelationshipCodes, getRelationshipId, getRelationships, getRemoteSystem, getRemoteSystem, getRemoteSystemCode, getRemoteSystemCodes, getRemoteSystemId, getRemoteSystems, getRepository, getRepositoryIdentifier, getReverseLookups, getReverseLookups, getTable, getTable, getTableCode, getTableCodes, getTableId, getTableIds, getTableSchema, getTableSchema, getTupleDefinition, getTupleDefinition, getTupleDefinitionIds, getTupleDefinitionSchema, getTupleDefinitionSchema, getTupleMemberField, getTupleMemberField, getTupleMemberFields, getTupleMemberFields
 

Method Detail

getRepositoryProperties

public RepositoryProperties getRepositoryProperties()
Returns repository properties

Returns:
repository properties

getUserNames

public String[] getUserNames()
Returns the array of user names.

Returns:
the array of user names.

getUser

public UserProperties getUser(String userName)
Returns the user properties for the specified user name

Parameters:
userName - the user name
Returns:
the user properties
Throws:
IllegalArgumentException - if specified user is not defined in repository

getUsers

public UserProperties[] getUsers()
Returns the properties for all users.

Returns:
the array of user properties

getRoleNames

public String[] getRoleNames()
Returns the array of role names.

Returns:
the array of role names.

getRole

public RoleProperties getRole(String roleName)
                       throws IllegalArgumentException
Returns the role properties for the specified role name

Parameters:
roleName - the role name
Returns:
the role properties
Throws:
IllegalArgumentException - if specified role is not defined in repository

getRoles

public RoleProperties[] getRoles()
Returns the properties for all roles.

Returns:
the array of role properties

getPorts

public PortProperties[] getPorts()
Returns the properties for all ports.

Returns:
the array of port properties

getPort

public PortProperties getPort(PortId portId)
                       throws IllegalArgumentException
Returns the port properties for the specified port

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

getPort

public PortProperties getPort(String portCode,
                              String remoteSystemCode,
                              int portType)
                       throws IllegalArgumentException
Returns the port properties for the specified port

Parameters:
portCode - the port Code
remoteSystemCode - the remote system code
portType - the port type
Returns:
the port properties
Throws:
IllegalArgumentException - if port doesn't exist in repository

getPortId

public PortId getPortId(String portCode,
                        String remoteSystemCode,
                        int portType)
                 throws IllegalArgumentException
Converts the port code to port ID

Parameters:
portCode - the port Code
remoteSystemCode - the remote system code
portType - the port type
Returns:
the port ID
Throws:
IllegalArgumentException - if port doesn't exist in repository

getPortCode

public String getPortCode(PortId portId)
                   throws IllegalArgumentException
Converts the port ID to port code

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

getRegion

public RegionProperties getRegion(Locale locale)
Returns region corresponded to the specified Locale

Parameters:
locale - instance of Locale class. Null if appropriate region is not found
Returns:
region properties. Null if appropriate region is not found.

getRegion

public RegionProperties getRegion(String regionNameOrCode)
Returns region corresponded to the specified region name

Parameters:
regionNameOrCode - the region name or region code.
Returns:
region properties. Null if appropriate region is not found

getRepositoryRegionInheritance

public RegionInheritanceProperties getRepositoryRegionInheritance(String regionCode)
Returns the region inheritance of the repository for specified region.

Parameters:
regionCode - region code.
Returns:
region inheritance. Null if appropriate region inheritance is not found.


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.