|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.sap.mdm.commands.AbstractCommandBase
com.sap.mdm.commands.AbstractCommand
com.sap.mdm.session.AbstractSessionCommand
com.sap.mdm.session.AbstractUserSessionCommand
com.sap.mdm.data.commands.RetrieveRecordsByIdCommand
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 |
public RetrieveRecordsByIdCommand(ConnectionAccessor connection)
connection - a connection to the MDM server
public RetrieveRecordsByIdCommand(UserSessionContext ctx)
throws ConnectionException,
SessionException
ctx - the user session context.| Method Detail |
public void setIds(RecordId[] recordIds)
recordIds - array of record IDspublic RecordId[] getIds()
public void addId(RecordId recordId)
recordId - record IDpublic void removeId(RecordId recordId)
recordId - record IDpublic boolean containsId(RecordId recordId)
recordId - record ID
true if the record is found, otherwise falsepublic void clearIds()
public ResultDefinition getResultDefinition()
AbstractRetrieveLimitedRecordsCommand.getResultDefinition()public void setResultDefinition(ResultDefinition resultDefinition)
resultDefinition - the result definitionAbstractRetrieveLimitedRecordsCommand.setResultDefinition(ResultDefinition)public ResultDefinition[] getSupportingResultDefinitions()
AbstractRetrieveLimitedRecordsCommand.getSupportingResultDefinitions()public void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
supportingResultDefinitions - the list of result definitionsAbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])public SortDefinition getFieldSortingOrder()
ResultDefinition.getFieldSortingOrder()
public void setFieldSortingOrder(SortDefinition fieldSorting)
ResultDefinition.getFieldSortingOrder()
fieldSorting - the field sorting orderpublic int getRegionalLayer()
public void setRegionalLayer(int regionalLayer)
RegionalLayer.CURRENT.
regionalLayer - the regional layerpublic boolean isRetrieveDisplayValue()
public void setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
true.
isRetrieveDisplayValue - the input parameters specifying if display value of the record should be retrievedpublic RecordResultSet getRecords()
public void SetRetrieveBareTextFromTextBlocksTable(boolean bVal)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
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.