|
|||||||||||
| 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.RetrieveRecordsByValueCommand
Retrieves records by field values. It works best on a field that has unique
field values. If there are multiple matches, the record selected is
indeterministic. If there is no match for a given field value, the returned
record will have a record Id of RecordId#INVALID_RECORD_ID.
The supported fields to match on are:
| Constructor Summary | |
RetrieveRecordsByValueCommand(ConnectionAccessor connection)
Creates an instance. |
|
RetrieveRecordsByValueCommand(UserSessionContext ctx)
Creates a new instance of this command by context. |
|
| Method Summary | |
FieldId |
getFieldId()
Returns the field Id. |
StringValue[] |
getFieldValues()
Returns the list of field values. |
RecordResultSet |
getRecords()
The records based on the provided field values. |
int |
getRegionalLayer()
Retrieves the regional layer. |
ResultDefinition |
getResultDefinition()
Returns the list of result definitions. |
RecordResultSet |
getResultSet()
Deprecated. instead use getRecords() method |
ResultDefinition[] |
getSupportingResultDefinitions()
Returns the list of result definitions. |
boolean |
isRetrieveDisplayValue()
Indicates if a display value of a record should be retrieved. |
void |
setFieldId(FieldId fieldId)
Sets the field to use for matching the field values (required). |
void |
setFieldValues(StringValue[] fieldValues)
Sets the field values to match (required). |
void |
setRegionalLayer(int regionalLayer)
Sets the regional layer to retrieve (optional). |
void |
setResultDefinition(ResultDefinition resultDefinition)
Sets the result definition (required). |
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 RetrieveRecordsByValueCommand(ConnectionAccessor connection)
connection - the connection to the MDM server
public RetrieveRecordsByValueCommand(UserSessionContext ctx)
throws ConnectionException,
SessionException
ctx - the user session context.| Method Detail |
public FieldId getFieldId()
public void setFieldId(FieldId fieldId)
fieldId - a field Idpublic StringValue[] getFieldValues()
public void setFieldValues(StringValue[] fieldValues)
fieldValues - the field valuespublic ResultDefinition getResultDefinition()
public void setResultDefinition(ResultDefinition resultDefinition)
resultDefinition - the result definitionpublic ResultDefinition[] getSupportingResultDefinitions()
AbstractRetrieveLimitedRecordsCommand.getSupportingResultDefinitions()public void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
supportingResultDefinitions - the list of result definitionsAbstractRetrieveLimitedRecordsCommand.setSupportingResultDefinitions(ResultDefinition[])public int getRegionalLayer()
public void setRegionalLayer(int regionalLayer)
RegionalLayer.CURRENT.
regionalLayer - the regional layerpublic RecordResultSet getResultSet()
public boolean isRetrieveDisplayValue()
public void setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
true.
isRetrieveDisplayValue - the input parameters specifying if display value of the record should be retrievedpublic RecordResultSet getRecords()
|
|||||||||||
| 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.