com.sap.mdm.data.commands
Class RetrieveLimitedRecordsCompoundCommand

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

public class RetrieveLimitedRecordsCompoundCommand
extends AbstractUserSessionCommand

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

RetrieveLimitedRecordsCompoundCommand

public RetrieveLimitedRecordsCompoundCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveLimitedRecordsCompoundCommand

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

Parameters:
ctx - the user session context.
Method Detail

getSearch

public Search getSearch()
Returns the search criteria.

Returns:
the search

setSearch

public void setSearch(Search search)
Sets the search criteria (required).

Parameters:
search - the search to set

getSearchDimensions

public SearchDimension[] getSearchDimensions()
Returns the search dimensions. The search dimensions defines the pick lists to retrieve.

Returns:
the search dimensions

setSearchDimensions

public void setSearchDimensions(SearchDimension[] searchDimensions)
Sets the search dimensions (optional). The search dimensions defines the pick lists to retrieve.

Parameters:
searchDimensions - the search dimensions

getSearchTableResultSet

public RecordResultSet getSearchTableResultSet()
Returns the result set for the search table. The result set contains the records that are matched by the search criteria.

Returns:
the result set

getSearchTableMatchCount

public int getSearchTableMatchCount()
Returns the match count of the search table.

Returns:
a match count

getPickLists

public PickList[] getPickLists()
Returns the limited pick lists.

Returns:
the limited pick lists

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

getResultDefinitions

public ResultDefinition[] getResultDefinitions()
Returns the result definitions. A result definition defines the fields/columns for which data are to be retrieved.

Returns:
the result definitions

setResultDefinitions

public void setResultDefinitions(ResultDefinition[] resultDefinitions)
Sets the result definitions (optional). A result definition defines the fields/columns for which data are to be retrieved. These result definitions apply to the search table result set and the pick lists.

Parameters:
resultDefinitions - the result definitions

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:
getResultDefinitions()

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

getPageIndex

public int getPageIndex()
Returns the paging index. The paging index is zero-based.

Returns:
the paging index
See Also:
getPageSize()

setPageIndex

public void setPageIndex(int pageIndex)
Sets the paging index (optional). The paging index is zero-based. The default is page index zero. It applies to the search table.

Parameters:
pageIndex - the paging index
See Also:
setPageSize(int)

getPageSize

public int getPageSize()
Returns the page size. The page size specifies the maximum number of records to retrieve.

Returns:
the page size
See Also:
getPageIndex()

setPageSize

public void setPageSize(int pageSize)
Sets the page size (optional). The page size specifies the maximum number of records to retrieve. The default page is 1000. It applies to the search table.

Parameters:
pageSize - the page size
See Also:
setPageIndex(int)

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

isRetrieveResultCounts

public boolean isRetrieveResultCounts()
Returns true if result counts should be retrieved, otherwise returns false.

Returns:
true if result counts should be retrieved, otherwise returns false
Since:
7.1 SP 3

setRetrieveResultCounts

public void setRetrieveResultCounts(boolean isRetrieveResultCounts)
Specifies whether to retrieve result counts or not.

Parameters:
isRetrieveResultCounts - true if result counts should be retrieved, otherwise returns false
Since:
7.1 SP 3

getExpandedNodes

public ExpandedNodes[] getExpandedNodes()
Returns the expanded nodes.

Returns:
the expanded nodes
Since:
7.1 SP 3

setExpandedNodes

public void setExpandedNodes(ExpandedNodes[] expandedNodes)
Specifies the expanded nodes for various search dimensions.

Parameters:
expandedNodes - the expanded nodes
Since:
7.1 SP 3
See Also:
ExpandedNodes


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.