|
|||||||||||
| 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.RetrieveLimitedRecordsCompoundCommand
A command for retrieving the list of limited records based on a search criteria. In addition, it also return the limited pick lists.
Note:
For search dimensions/pick list, only FieldSearchDimension and
MaskSearchDimension are currently supported.
| Constructor Summary | |
RetrieveLimitedRecordsCompoundCommand(ConnectionAccessor connection)
Creates an instance. |
|
RetrieveLimitedRecordsCompoundCommand(UserSessionContext ctx)
Creates a new instance of this command by context. |
|
| Method Summary | |
ExpandedNodes[] |
getExpandedNodes()
Returns the expanded nodes. |
int |
getPageIndex()
Returns the paging index. |
int |
getPageSize()
Returns the page size. |
PickList[] |
getPickLists()
Returns the limited pick lists. |
int |
getRegionalLayer()
Retrieves the regional layer. |
ResultDefinition[] |
getResultDefinitions()
Returns the result definitions. |
Search |
getSearch()
Returns the search criteria. |
SearchDimension[] |
getSearchDimensions()
Returns the search dimensions. |
int |
getSearchTableMatchCount()
Returns the match count of the search table. |
RecordResultSet |
getSearchTableResultSet()
Returns the result set for the search table. |
ResultDefinition[] |
getSupportingResultDefinitions()
Returns the list of result definitions. |
boolean |
isRetrieveDisplayValue()
Indicates if a display value of a record should be retrieved. |
boolean |
isRetrieveResultCounts()
Returns true if result counts should be retrieved, otherwise returns false. |
void |
setExpandedNodes(ExpandedNodes[] expandedNodes)
Specifies the expanded nodes for various search dimensions. |
void |
setPageIndex(int pageIndex)
Sets the paging index (optional). |
void |
setPageSize(int pageSize)
Sets the page size (optional). |
void |
setRegionalLayer(int regionalLayer)
Sets the regional layer to retrieve (optional). |
void |
setResultDefinitions(ResultDefinition[] resultDefinitions)
Sets the result definitions (optional). |
void |
setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
Defines if display value of the record should be retrieved (optional). |
void |
setRetrieveResultCounts(boolean isRetrieveResultCounts)
Specifies whether to retrieve result counts or not. |
void |
setSearch(Search search)
Sets the search criteria (required). |
void |
setSearchDimensions(SearchDimension[] searchDimensions)
Sets the search dimensions (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 RetrieveLimitedRecordsCompoundCommand(ConnectionAccessor connection)
connection - the connection to the MDM server
public RetrieveLimitedRecordsCompoundCommand(UserSessionContext ctx)
throws ConnectionException,
SessionException
ctx - the user session context.| Method Detail |
public Search getSearch()
public void setSearch(Search search)
search - the search to setpublic SearchDimension[] getSearchDimensions()
public void setSearchDimensions(SearchDimension[] searchDimensions)
searchDimensions - the search dimensionspublic RecordResultSet getSearchTableResultSet()
public int getSearchTableMatchCount()
public PickList[] getPickLists()
public int getRegionalLayer()
public void setRegionalLayer(int regionalLayer)
RegionalLayer.CURRENT.
regionalLayer - the regional layerpublic ResultDefinition[] getResultDefinitions()
public void setResultDefinitions(ResultDefinition[] resultDefinitions)
resultDefinitions - the result definitionspublic ResultDefinition[] getSupportingResultDefinitions()
getResultDefinitions()public void setSupportingResultDefinitions(ResultDefinition[] supportingResultDefinitions)
supportingResultDefinitions - the list of result definitionspublic int getPageIndex()
getPageSize()public void setPageIndex(int pageIndex)
pageIndex - the paging indexsetPageSize(int)public int getPageSize()
getPageIndex()public void setPageSize(int pageSize)
pageSize - the page sizesetPageIndex(int)public boolean isRetrieveDisplayValue()
public void setRetrieveDisplayValue(boolean isRetrieveDisplayValue)
true.
isRetrieveDisplayValue - the input parameters specifying if display value of the record should be retrievedpublic boolean isRetrieveResultCounts()
true if result counts should be retrieved, otherwise returns false.
true if result counts should be retrieved, otherwise returns falsepublic void setRetrieveResultCounts(boolean isRetrieveResultCounts)
isRetrieveResultCounts - true if result counts should be retrieved, otherwise returns falsepublic ExpandedNodes[] getExpandedNodes()
public void setExpandedNodes(ExpandedNodes[] expandedNodes)
expandedNodes - the expanded nodesExpandedNodes
|
|||||||||||
| 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.