com.sap.mdm.matchingsets.commands
Class RetrieveMatchingTaxonomyRecordsCommand

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

public class RetrieveMatchingTaxonomyRecordsCommand
extends AbstractUserSessionCommand

A command to retrieve the matching taxonomy records given a record in the main table. This is based on matching sets.

Since:
5.5. SP6 Patch 04
See Also:
RetrieveMatchingSetsCommand, RetrieveMatchingSearchCommand

Constructor Summary
RetrieveMatchingTaxonomyRecordsCommand(ConnectionAccessor connection)
          Creates an instance of this command.
RetrieveMatchingTaxonomyRecordsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId getRecordId()
          Returns the source record Id.
 RecordResultSet getRecords()
          Returns the matching taxonomy records.
 int getRegionalLayer()
          Returns the regional layer.
 ResultDefinition getResultDefinition()
          Returns the result definition.
 ResultDefinition[] getSupportingResultDefinitions()
          Returns the list of result definitions.
 TableId getTableId()
          Returns the table Id of the source record.
 FieldId getTaxonomyFieldId()
          Returns the taxonomy field Id.
 void setRecordId(RecordId recordId)
          Sets the source record Id (required).
 void setRegionalLayer(int regionalLayer)
          Sets the regional layer to retrieve (optional).
 void setResultDefinition(ResultDefinition resultDefinition)
          Sets the result definition for the taxonomy table (required).
 void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
          Sets the list of result definitions (optional).
 void setTableId(TableId tableId)
          Sets the table Id of the source record (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

RetrieveMatchingTaxonomyRecordsCommand

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

Parameters:
connection - the connection to the server

RetrieveMatchingTaxonomyRecordsCommand

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

Parameters:
ctx - the user session context.
Method Detail

getResultDefinition

public ResultDefinition getResultDefinition()
Returns the result definition. The result definition specifies the list of field/columns to retrieve the data for.

Returns:
the result definition
See Also:
AbstractRetrieveLimitedRecordsCommand.getSupportingResultDefinitions()

setResultDefinition

public void setResultDefinition(ResultDefinition resultDefinition)
Sets the result definition for the taxonomy table (required). The result definition specifies the list of field/columns to retrieve the data for.

Parameters:
resultDefinition - the result definition
See Also:
AbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])

getSupportingResultDefinitions

public ResultDefinition[] getSupportingResultDefinitions()
Returns the list of result definitions. These result definitions specify the list of fields/columns to retrieve for supporting lookup fields from the main result definition.

Returns:
the list of result definitions
See Also:
AbstractRetrieveLimitedRecordsCommand.getResultDefinition()

setSupportingResultDefinitions

public void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
Sets the list of result definitions (optional). These result definitions specify the list of fields/columns to retrieve for supporting lookup fields from the main result definition.

Parameters:
supportingResultDefinitions - the list of result definitions

getRegionalLayer

public int getRegionalLayer()
Returns the regional layer.

Returns:
the regional layer

setRegionalLayer

public void setRegionalLayer(int regionalLayer)
Sets the regional layer to retrieve (optional). The default is RegionalLayer.CURRENT.

Parameters:
regionalLayer - the regional layer

getRecords

public RecordResultSet getRecords()
Returns the matching taxonomy records.

Returns:
the record result set

getTableId

public TableId getTableId()
Returns the table Id of the source record.

Returns:
a table Id

setTableId

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

Parameters:
tableId - a table Id

getTaxonomyFieldId

public FieldId getTaxonomyFieldId()
Returns the taxonomy field Id.

Returns:
a taxonomy field Id

setTaxonomyFieldId

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

Parameters:
taxonomyFieldId - a taxonomy 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


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.