com.sap.mdm.data.commands
Class RetrieveRecordIdsByRemoteKeyCommand

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.RetrieveRecordIdsByRemoteKeyCommand
All Implemented Interfaces:
Command, PassportSupport

public class RetrieveRecordIdsByRemoteKeyCommand
extends AbstractUserSessionCommand

This command is responsible for retrieving set of Record IDs by remote keys.


Constructor Summary
RetrieveRecordIdsByRemoteKeyCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveRecordIdsByRemoteKeyCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId[] getRecordIds()
          Returns result set of record IDs.
 KeyMapping getRemoteKeys()
          Gets remote key for which record IDs should be retrieved from repository.
 TableId getTableId()
          Gets ID of table for which record should be retrieved.
 void setRemoteKeys(KeyMapping remoteKeys)
          Set remote key for which record IDs should be retrieved from repository (required).
 void setTableId(TableId tableId)
          Set ID of table for which record should be retrieved (required).
 
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

RetrieveRecordIdsByRemoteKeyCommand

public RetrieveRecordIdsByRemoteKeyCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - a connection to the MDM server

RetrieveRecordIdsByRemoteKeyCommand

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

Parameters:
ctx - the user session context.
Method Detail

setTableId

public void setTableId(TableId tableId)
Set ID of table for which record should be retrieved (required).

Parameters:
tableId - table ID

getTableId

public TableId getTableId()
Gets ID of table for which record should be retrieved.

Returns:
table ID

setRemoteKeys

public void setRemoteKeys(KeyMapping remoteKeys)
Set remote key for which record IDs should be retrieved from repository (required).

Parameters:
remoteKeys - remote keys

getRemoteKeys

public KeyMapping getRemoteKeys()
Gets remote key for which record IDs should be retrieved from repository.

Returns:
remote keys

getRecordIds

public RecordId[] getRecordIds()
Returns result set of record IDs.

Returns:
array of record IDs


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.