com.sap.mdm.data
Interface KeyMapping

All Superinterfaces:
Cloneable

public interface KeyMapping
extends Cloneable

This interface represents key mapping for a single remote system. Key mapping is a set of remote keys that maps object in MDM repository (for example, record or attribute value) to equivalent object in remote system

See Also:
KeyMappingSet, RecordKeyMapping, AttributeKeyMapping

Method Summary
 void addKey(String key)
          Add key to list of keys
 Object clone()
          Returns a clone.
 boolean containsKey(String key)
          Check if the specified key is contained in this key mapping
 String getDefaultKey()
          Get default key
 String[] getKeys()
          Get array of all keys
 RemoteSystemId getRemoteSystem()
          Get ID of Remote System specifying this key mapping
 boolean isDefaultKey(String key)
          Check if the specified key as default.
 void removeAllKeys()
          Remove all keys from list
 void removeKey(String key)
          Remove the specified key from the list of keys
 void setDefaultKey(String defaultKey)
          Set specified key as default.
 void setKeys(String[] keys)
          Set a new set of keys
 

Method Detail

getRemoteSystem

public RemoteSystemId getRemoteSystem()
Get ID of Remote System specifying this key mapping

Returns:
remote system ID

getKeys

public String[] getKeys()
Get array of all keys

Returns:
array of keys

setKeys

public void setKeys(String[] keys)
Set a new set of keys

Parameters:
keys - new keys

getDefaultKey

public String getDefaultKey()
Get default key

Returns:
default key

setDefaultKey

public void setDefaultKey(String defaultKey)
                   throws IllegalArgumentException
Set specified key as default.

Parameters:
defaultKey - default key
Throws:
IllegalArgumentException - if specified key does not belong to key mapping

isDefaultKey

public boolean isDefaultKey(String key)
Check if the specified key as default.

Parameters:
key - to check
Returns:
true if the specified key is default key, else otherwise

addKey

public void addKey(String key)
            throws IllegalArgumentException
Add key to list of keys

Parameters:
key - new key to add
Throws:
IllegalArgumentException - if specified key already exist in key mapping

removeKey

public void removeKey(String key)
               throws IllegalArgumentException
Remove the specified key from the list of keys

Parameters:
key - key to remove
Throws:
IllegalArgumentException - if specified key does not belong to key mapping

removeAllKeys

public void removeAllKeys()
Remove all keys from list


containsKey

public boolean containsKey(String key)
Check if the specified key is contained in this key mapping

Parameters:
key - key for checking
Returns:
true if key mapping contains specified key, false otherwise

clone

public Object clone()
Returns a clone.

Returns:
a clone


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.