com.sap.mdm.data.commands
Class CheckoutRecordsCommand

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

public class CheckoutRecordsCommand
extends AbstractRecordsByIdCommand

This command is responsible for checking out a set of records by record IDs.

See Also:
CheckinRecordsCommand, RollbackRecordsCommand

Constructor Summary
CheckoutRecordsCommand(ConnectionAccessor connection)
          Constructor
CheckoutRecordsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId[] getCheckOutRecordIds()
          Returns the new record Ids for the checked out records.
 RecordId[] getCheckOutRecordIds(boolean allSucceeded)
          Returns the new record Ids for the checked out records.
 RecordId[] getFailedRecords()
          Returns the records that failed to check-out.
 Integer getReturnCode(RecordId recordId)
          Returns the reason the record failed to check-out.
 RecordId[] getSucceededRecords()
          Returns the records that were successfully checked out.
 boolean isExclusive()
          Specify if checkout should be done exclusively.
 boolean isSlice()
          Returns whether slicing is enabled.
 void setExclusive(boolean isExclusive)
          Specify if checkout should be done exclusively (optional).
 void setSlice(boolean isSlice)
          Enable slicing during check-out.
 
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

CheckoutRecordsCommand

public CheckoutRecordsCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

CheckoutRecordsCommand

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

Parameters:
ctx - the user session context.
Method Detail

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 new record Ids for the checked out records. If a record failed to checkout, the new record Id is less than one.

Returns:
list of record Ids

getCheckOutRecordIds

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

Parameters:
allSucceeded - If true, return only records that were successfully checked out. The index position matches the index position from getSucceededRecords(). If false, returns records that were successfully checked out and for records that failed to check out. The index position matches the index position from AbstractRecordIdsCommand.getRecordIds().
Returns:
list of record Ids
Since:
7.1 SP6

setSlice

public void setSlice(boolean isSlice)
Enable slicing during check-out.

Parameters:
isSlice - true to enable, false to disable
Since:
7.1 SP6

isSlice

public boolean isSlice()
Returns whether slicing is enabled.

Returns:
true to enable, false to disable
Since:
7.1 SP6

getFailedRecords

public RecordId[] getFailedRecords()
Returns the records that failed to check-out.

Note: When slicing is enabled, records are divided into subsets. For a given subset of records, if a record failed the operation, the whole subset of records are marked as failed. It is not possible to determine which record in the subset triggered the failure.

Returns:
the list of failed records
Since:
7.1 SP6

getSucceededRecords

public RecordId[] getSucceededRecords()
Returns the records that were successfully checked out.

Returns:
the list of succeeded records
Since:
7.1 SP6

getReturnCode

public Integer getReturnCode(RecordId recordId)
Returns the reason the record failed to check-out.

Parameters:
recordId - a record Id
Returns:
returns the return code for the failed record; if it's not a failed record, return null
Since:
7.1 SP6
See Also:
RC


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.