com.sap.mdm.matching.commands
Class ExecuteMatchingStrategyForNewRecordValuesCommand

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

public class ExecuteMatchingStrategyForNewRecordValuesCommand
extends AbstractUserSessionCommand

A command to execute a matching strategy for external source records. Executing a matching strategy involves a matching strategy, the source records and the target records.

The source records are the external records. The target records are specified as a list of records or as a search criteria.

TerminateMatchingStrategyCommand should be used when the results of the matching strategy is no longer need. It will free up resources needed to maintain the results of the matching strategy.

Note: Currently qualifier values are not supported.

See Also:
com.sap.mdm.matching.commands, TerminateMatchingStrategyCommand

Constructor Summary
ExecuteMatchingStrategyForNewRecordValuesCommand(ConnectionAccessor connection)
          Creates a new instance of this command.
ExecuteMatchingStrategyForNewRecordValuesCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 MatchingTaskId getMatchingTaskId()
          Returns the matching task Id.
 Record[] getSource()
          Returns the source records.
 int getSourceRecordCount()
          Returns the source records count.
 MatchingStrategyId getStrategyId()
          Returns the matching strategy Id.
 TableId getTableId()
          Returns the table Id.
 void setSource(Record[] records)
          Sets the source records (required).
 void setStrategyId(MatchingStrategyId strategId)
          Sets the matching strategy Id (required).
 void setTableId(TableId tableId)
          Sets the table Id (required) for which the matching strategy is defined.
 void setTarget(RecordId[] recordIds)
          Sets the target records (required*).
 void setTarget(Search search)
          Sets the target records in a form of a search object (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

ExecuteMatchingStrategyForNewRecordValuesCommand

public ExecuteMatchingStrategyForNewRecordValuesCommand(ConnectionAccessor connection)
Creates a new instance of this command.

Parameters:
connection - the connections to the server.

ExecuteMatchingStrategyForNewRecordValuesCommand

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

Parameters:
ctx - the user session context.
Method Detail

getSource

public Record[] getSource()
Returns the source records.

Returns:
the source records

setSource

public void setSource(Record[] records)
Sets the source records (required). These are the records to find matching for. Currently only one record is supported.

Parameters:
records - a list of records

setTarget

public void setTarget(RecordId[] recordIds)
Sets the target records (required*). These are the records to match to.

Parameters:
recordIds - a list of record Ids

setTarget

public void setTarget(Search search)
Sets the target records in a form of a search object (required*). These are the records to match to.

Parameters:
search - the search object

getStrategyId

public MatchingStrategyId getStrategyId()
Returns the matching strategy Id.

Returns:
a matching strategy id

setStrategyId

public void setStrategyId(MatchingStrategyId strategId)
Sets the matching strategy Id (required). This is the matching strategy to execute.

Parameters:
strategId - a matching strategy Id
See Also:
RetrieveMatchingStrategiesCommand

getMatchingTaskId

public MatchingTaskId getMatchingTaskId()
Returns the matching task Id. This matching task Id is a handle to the matching strategy that was executed. This handle is use in subsequence matching commands.

Returns:
a matching task Id

getSourceRecordCount

public int getSourceRecordCount()
Returns the source records count. This is useful when the source records is specified as a search object.

Returns:
the source record count

getTableId

public TableId getTableId()
Returns the table Id.

Returns:
a table Id

setTableId

public void setTableId(TableId tableId)
Sets the table Id (required) for which the matching strategy is defined.

Parameters:
tableId - a table 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.