com.sap.mdm.data.commands
Class CheckoutRecordsAsNewCommand

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

public class CheckoutRecordsAsNewCommand
extends AbstractUserSessionCommand

This command checks out non-existent records. New records are not created until the checked out records are checked in.

See Also:
CheckoutRecordsCommand

Constructor Summary
CheckoutRecordsAsNewCommand(ConnectionAccessor connection)
          Constructor
CheckoutRecordsAsNewCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId[] getCheckOutRecordIds()
          Returns the record Ids of the new checked out records.
 TableId getTableId()
          Returns the table ID.
 boolean isExclusive()
          Specify if checkout should be done exclusively.
 void setExclusive(boolean isExclusive)
          Specify if checkout should be done exclusively (optional).
 void setTableId(TableId tableId)
          Sets the table ID (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

CheckoutRecordsAsNewCommand

public CheckoutRecordsAsNewCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

CheckoutRecordsAsNewCommand

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

Parameters:
ctx - the user session context.
Method Detail

getTableId

public TableId getTableId()
Returns the table ID.

Returns:
the table ID

setTableId

public void setTableId(TableId tableId)
Sets the table ID (required).

Parameters:
tableId - the table ID.

isExclusive

public boolean isExclusive()
Specify if checkout should be done exclusively.

Returns:
true if checkout will be done exclusively

setExclusive

public void setExclusive(boolean isExclusive)
Specify if checkout should be done exclusively (optional). The default is true.

Parameters:
isExclusive - true if checkout will be done exclusively

getCheckOutRecordIds

public RecordId[] getCheckOutRecordIds()
Returns the record Ids of the new checked out records.

Note: The current implementation only allow for checking out one record at a time. If the command executes successfully, the following is always true.

getRecordIds().length > 0

Returns:
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.