com.sap.mdm.data.commands
Class RetrieveCheckoutRecordsByOriginalCommand

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.RetrieveCheckoutRecordsByOriginalCommand
All Implemented Interfaces:
Command

public class RetrieveCheckoutRecordsByOriginalCommand
extends AbstractRecordsByIdCommand

A command to allow for retrieving the checked out record given the original record Ids are known.

See Also:
CheckoutRecordsCommand, RetrieveOriginalsByCheckoutRecordCommand

Constructor Summary
RetrieveCheckoutRecordsByOriginalCommand(ConnectionAccessor connection)
          Constructor
RetrieveCheckoutRecordsByOriginalCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 void execute()
          Executes the command.
 RecordId[] getCheckOutRecords(RecordId originalRecordId)
          Returns the checked out record given the original record Id.
 
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
isCommandComplete
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RetrieveCheckoutRecordsByOriginalCommand

public RetrieveCheckoutRecordsByOriginalCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

RetrieveCheckoutRecordsByOriginalCommand

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

Parameters:
ctx - the user session context.
Method Detail

execute

public void execute()
             throws CommandException
Description copied from interface: Command
Executes the command.

Specified by:
execute in interface Command
Overrides:
execute in class AbstractRecordsByIdCommand
Throws:
CommandException

getCheckOutRecords

public RecordId[] getCheckOutRecords(RecordId originalRecordId)
Returns the checked out record given the original record Id. The return parameter is an array to accommodate future scenarios. Currently the number of records returned is always a size of one.

Parameters:
originalRecordId - the original record Id
Returns:
the checked out record Id.


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.