com.sap.mdm.matchingsets.commands
Class RetrieveMatchingSearchCommand

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

public class RetrieveMatchingSearchCommand
extends AbstractUserSessionCommand

A command to constructor a search criteria based on a source record and a matching taxonomy record.

Since:
5.5. SP6 Patch 04
See Also:
RetrieveMatchingTaxonomyRecordsCommand

Constructor Summary
RetrieveMatchingSearchCommand(ConnectionAccessor connection)
          Creates an instance of this command.
RetrieveMatchingSearchCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId getMatchingTaxonomyId()
          Returns the matching node Id.
 RecordId getRecordId()
          Returns the source record Id.
 Search getSearch()
          Returns the search object.
 TableId getTableId()
          Returns the table Id.
 FieldId getTaxonomyFieldId()
          Returns the taxonomy field Id.
 boolean isIncludeNull()
          Returns true if include null search constraint in the search criteria, otherwise false.
 void setIncludeNull(boolean isIncludeNull)
          Sets whether to include null search constraint or not.
 void setMatchingTaxonomyId(RecordId matchingNodeId)
          Sets the matching taxonomy Id (required).
 void setRecordId(RecordId recordId)
          Sets the source record Id (required).
 void setTableId(TableId tableId)
          Sets the table Id (required).
 void setTaxonomyFieldId(FieldId taxonomyFieldId)
          Sets the taxonomy field 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

RetrieveMatchingSearchCommand

public RetrieveMatchingSearchCommand(ConnectionAccessor connection)
Creates an instance of this command.

Parameters:
connection - the connection to the server

RetrieveMatchingSearchCommand

public RetrieveMatchingSearchCommand(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:
a table Id

setTableId

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

Parameters:
tableId - a table Id

getTaxonomyFieldId

public FieldId getTaxonomyFieldId()
Returns the taxonomy field Id.

Returns:
a field Id

setTaxonomyFieldId

public void setTaxonomyFieldId(FieldId taxonomyFieldId)
Sets the taxonomy field Id (required).

Parameters:
taxonomyFieldId - a field Id

getRecordId

public RecordId getRecordId()
Returns the source record Id.

Returns:
a record Id

setRecordId

public void setRecordId(RecordId recordId)
Sets the source record Id (required).

Parameters:
recordId - a record Id

getMatchingTaxonomyId

public RecordId getMatchingTaxonomyId()
Returns the matching node Id.

Returns:
a record Id

setMatchingTaxonomyId

public void setMatchingTaxonomyId(RecordId matchingNodeId)
Sets the matching taxonomy Id (required).

Parameters:
matchingNodeId - a record Id.
See Also:
RetrieveMatchingTaxonomyRecordsCommand

getSearch

public Search getSearch()
Returns the search object.

Returns:
a search object

isIncludeNull

public boolean isIncludeNull()
Returns true if include null search constraint in the search criteria, otherwise false.

Returns:
true if include null otherwise false

setIncludeNull

public void setIncludeNull(boolean isIncludeNull)
Sets whether to include null search constraint or not. The default is false.

Parameters:
isIncludeNull - true if include null search constraint, otherwise false


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.