com.sap.mdm.data.commands
Class MergeRecordsCommand

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

public class MergeRecordsCommand
extends AbstractUserSessionCommand

A command to merge multiple records into one record.


Constructor Summary
MergeRecordsCommand(ConnectionAccessor connection)
          Constructor
MergeRecordsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId getMergedRecordId()
          Returns the record Id of the newly merged record.
 Record getMergeRecordValues()
          Returns the record values for the merged record.
 RecordId[] getRecordIds()
          Returns the list of records to merge.
 TableId getTableId()
          Returns the table Id.
 ValidationResult getValidationResult()
          Returns the validation results.
 boolean isCommitOnWarning()
          Indicates whether the record should be committed if the record failed the "warning" validations.
 void setCommitOnWarning(boolean isCommitOnWarning)
          Indicates whether the record should be committed if the record failed the "warning" validations.
 void setMergeRecordValues(Record recordValues)
          Sets the record values for the merged record (required).
 void setRecordIds(RecordId[] records)
          Sets the records to merge (required).
 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

MergeRecordsCommand

public MergeRecordsCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

MergeRecordsCommand

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

Parameters:
ctx - the user session context.
Method Detail

getRecordIds

public RecordId[] getRecordIds()
Returns the list of records to merge.

Returns:
a list of records

setRecordIds

public void setRecordIds(RecordId[] records)
Sets the records to merge (required).

Parameters:
records - a list of records

getTableId

public TableId getTableId()
Returns the table Id.

Returns:
a table Id

setTableId

public void setTableId(TableId tableId)
Sets the table Id (required). The records are assume to be from this table.

Parameters:
tableId - a table Id

getMergeRecordValues

public Record getMergeRecordValues()
Returns the record values for the merged record.

Returns:
the record values

setMergeRecordValues

public void setMergeRecordValues(Record recordValues)
Sets the record values for the merged record (required). Note, the record Id is not use.

Parameters:
recordValues - the record values

getMergedRecordId

public RecordId getMergedRecordId()
Returns the record Id of the newly merged record.

Returns:
a record Id

isCommitOnWarning

public boolean isCommitOnWarning()
Indicates whether the record should be committed if the record failed the "warning" validations.

Returns:
true to commit, false otherwise
Since:
7.1 SP7

setCommitOnWarning

public void setCommitOnWarning(boolean isCommitOnWarning)
Indicates whether the record should be committed if the record failed the "warning" validations.

Parameters:
isCommitOnWarning - true to commit, false otherwise
Since:
7.1 SP7

getValidationResult

public ValidationResult getValidationResult()
Returns the validation results.

Returns:
validation results
Since:
7.1 SP7


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.