com.sap.mdm.data.commands
Class RetrieveRecordsKeyMappingsCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommand
          extended bycom.sap.mdm.session.AbstractSessionCommand
              extended bycom.sap.mdm.session.AbstractUserSessionCommand
                  extended bycom.sap.mdm.data.commands.AbstractRecordIdsCommand
                      extended bycom.sap.mdm.data.commands.AbstractRecordsByIdCommand
                          extended bycom.sap.mdm.data.commands.RetrieveRecordsKeyMappingsCommand
All Implemented Interfaces:
Command, PassportSupport

public class RetrieveRecordsKeyMappingsCommand
extends AbstractRecordsByIdCommand

Retrieves set of key mappings for set set of records.

See Also:
RetrieveAttributesKeyMappingsCommand, ModifyRecordsKeyMappingsCommand

Constructor Summary
RetrieveRecordsKeyMappingsCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveRecordsKeyMappingsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordKeyMapping[] getKeyMappings()
          Returns key mappings for all records.
 boolean isDefaultKeysOnly()
          Indicates whether only default keys should be loaded.
 void setDefaultKeysOnly(boolean isDefaultKeysOnly)
          Indicates whether only default keys should be loaded.
 
Methods inherited from class com.sap.mdm.data.commands.AbstractRecordsByIdCommand
getTableId, setTableId
 
Methods inherited from class com.sap.mdm.data.commands.AbstractRecordIdsCommand
addRecordId, clearRecordIds, containsRecordId, getRecordIds, removeRecordId, setRecordIds
 
Methods inherited from class com.sap.mdm.commands.AbstractCommand
getSession, setSession
 
Methods inherited from class com.sap.mdm.commands.AbstractCommandBase
execute, getPassport, isCommandComplete, setPassport
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RetrieveRecordsKeyMappingsCommand

public RetrieveRecordsKeyMappingsCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveRecordsKeyMappingsCommand

public RetrieveRecordsKeyMappingsCommand(UserSessionContext ctx)
                                  throws ConnectionException,
                                         SessionException
Creates a new instance of this command by context.

Parameters:
ctx - the user session context.
Method Detail

isDefaultKeysOnly

public boolean isDefaultKeysOnly()
Indicates whether only default keys should be loaded.

Returns:
true if only default keys are loaded, else otherwise

setDefaultKeysOnly

public void setDefaultKeysOnly(boolean isDefaultKeysOnly)
Indicates whether only default keys should be loaded. The default is false.

Parameters:
isDefaultKeysOnly - specifies if only the default keys are loaded

getKeyMappings

public RecordKeyMapping[] getKeyMappings()
Returns key mappings for all records.

Returns:
array of RecordKeyMapping


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.