com.sap.mdm.data.commands
Class RetrieveRecordsByIdCommand

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.RetrieveRecordsByIdCommand
All Implemented Interfaces:
Command, PassportSupport
Direct Known Subclasses:
RetrieveRecordsByIdExCommand

public class RetrieveRecordsByIdCommand
extends AbstractUserSessionCommand

This command is responsible for retrieving set of Record by record IDs.


Constructor Summary
RetrieveRecordsByIdCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveRecordsByIdCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 void addId(RecordId recordId)
          Adds a record ID to the list of IDs that should be retrieved from repository (required*).
 void clearIds()
          Clears the list of record IDs.
 boolean containsId(RecordId recordId)
          Checks if the specified record ID is contained in the list of IDs that should be retrieved from repository.
 SortDefinition getFieldSortingOrder()
          Deprecated. replaced by ResultDefinition.getFieldSortingOrder()
 RecordId[] getIds()
          Gets record IDs that should be retrieved from repository.
 RecordResultSet getRecords()
          Gets result set of record retrieved from repository.
 int getRegionalLayer()
          Retrieves the regional layer.
 ResultDefinition getResultDefinition()
          Returns the result definition.
 ResultDefinition[] getSupportingResultDefinitions()
          Returns the list of result definitions.
 boolean isRetrieveDisplayValue()
          Indicates if a display value of a record should be retrieved.
 void removeId(RecordId recordId)
          Removes a record ID from the list of IDs that should be retrieved from repository
 void setFieldSortingOrder(SortDefinition fieldSorting)
          Deprecated. replaced by ResultDefinition.getFieldSortingOrder()
 void setIds(RecordId[] recordIds)
          Set record IDs that should be retrieved from repository (required*).
 void setRegionalLayer(int regionalLayer)
          Sets the regional layer to retrieve (optional).
 void setResultDefinition(ResultDefinition resultDefinition)
          Sets the result definition (required).
 void SetRetrieveBareTextFromTextBlocksTable(boolean bVal)
           
 void setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
          Defines if display value of the record should be retrieved (optional).
 void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
          Sets the list of result definitions (optional).
 
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

RetrieveRecordsByIdCommand

public RetrieveRecordsByIdCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - a connection to the MDM server

RetrieveRecordsByIdCommand

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

Parameters:
ctx - the user session context.
Method Detail

setIds

public void setIds(RecordId[] recordIds)
Set record IDs that should be retrieved from repository (required*).

Parameters:
recordIds - array of record IDs

getIds

public RecordId[] getIds()
Gets record IDs that should be retrieved from repository.

Returns:
array of record IDs

addId

public void addId(RecordId recordId)
Adds a record ID to the list of IDs that should be retrieved from repository (required*).

Parameters:
recordId - record ID

removeId

public void removeId(RecordId recordId)
Removes a record ID from the list of IDs that should be retrieved from repository

Parameters:
recordId - record ID

containsId

public boolean containsId(RecordId recordId)
Checks if the specified record ID is contained in the list of IDs that should be retrieved from repository.

Parameters:
recordId - record ID
Returns:
true if the record is found, otherwise false

clearIds

public void clearIds()
Clears the list of record IDs.


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.getResultDefinition()

setResultDefinition

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

Parameters:
resultDefinition - the result definition
See Also:
AbstractRetrieveLimitedRecordsCommand.setResultDefinition(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.getSupportingResultDefinitions()

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
See Also:
AbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])

getFieldSortingOrder

public SortDefinition getFieldSortingOrder()
Deprecated. replaced by ResultDefinition.getFieldSortingOrder()

Returns the field sorting order. The default is no sorting.

Returns:
the field sorting order

setFieldSortingOrder

public void setFieldSortingOrder(SortDefinition fieldSorting)
Deprecated. replaced by ResultDefinition.getFieldSortingOrder()

Sets the field sorting order (optional). The default is no sorting.

Parameters:
fieldSorting - the field sorting order

getRegionalLayer

public int getRegionalLayer()
Retrieves 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

isRetrieveDisplayValue

public boolean isRetrieveDisplayValue()
Indicates if a display value of a record should be retrieved.

Returns:
true if display value of a record should be retrieved, false otherwise.

setRetrieveDisplayValue

public void setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
Defines if display value of the record should be retrieved (optional). The default is true.

Parameters:
isRetrieveDisplayValue - the input parameters specifying if display value of the record should be retrieved

getRecords

public RecordResultSet getRecords()
Gets result set of record retrieved from repository.

Returns:
result set of records

SetRetrieveBareTextFromTextBlocksTable

public void SetRetrieveBareTextFromTextBlocksTable(boolean bVal)


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.