com.sap.mdm.data.commands
Class RetrieveLimitedTupleValuesCommand

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.RetrieveLimitedTupleValuesCommand
All Implemented Interfaces:
Command, PassportSupport

public class RetrieveLimitedTupleValuesCommand
extends AbstractUserSessionCommand

A command to retrieve the limited tuple values. This command is useful when certain multi-valued tuple fields have hundreds of tuple records.

Since:
7.1

Constructor Summary
RetrieveLimitedTupleValuesCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveLimitedTupleValuesCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 int getPageIndex()
          Returns the paging index.
 int getPageSize()
          Returns the page size.
 int getRegionalLayer()
          Retrieves the regional layer.
 ResultDefinition getResultDefinition()
          Returns the result definition.
 int getSearchMatchCount()
          Return the record count.
 ResultDefinition[] getSupportingResultDefinitions()
          Returns the list of result definitions.
 TupleSearch getTupleSearch()
          Returns the search criteria.
 MultiTupleValue getValues()
          Returns the tuple records that satisfy the search criteria.
 boolean isRetrieveDisplayValue()
          Indicates if a display value of a record should be retrieved.
 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 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).
 void setTupleSearch(TupleSearch tupleSearch)
          Sets the search criteria (required).
 
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

RetrieveLimitedTupleValuesCommand

public RetrieveLimitedTupleValuesCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - a connection to the MDM server

RetrieveLimitedTupleValuesCommand

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

Parameters:
ctx - the user session context.
Method Detail

getTupleSearch

public TupleSearch getTupleSearch()
Returns the search criteria. The search criteria specifies the search table and what to search for.

Returns:
the search criteria

setTupleSearch

public void setTupleSearch(TupleSearch tupleSearch)
Sets the search criteria (required). The search criteria specifies the search table and what to search for.

Parameters:
tupleSearch - the search criteria

getPageIndex

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

Returns:
the paging index
See Also:
RetrieveLimitedRecordsCommand.getPageSize()

setPageIndex

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

Parameters:
pageIndex - the paging index
See Also:
RetrieveLimitedRecordsCommand.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:
RetrieveLimitedRecordsCommand.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.

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

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

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

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

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

getSearchMatchCount

public int getSearchMatchCount()
Return the record count.

Returns:
a record count

getValues

public MultiTupleValue getValues()
Returns the tuple records that satisfy the search criteria.

Returns:
tuple records


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.