com.sap.mdm.data.commands
Class RetrieveLimitedRecordsCommand

java.lang.Object
  com.sap.mdm.commands.AbstractCommandBase
      com.sap.mdm.commands.AbstractCommand
          com.sap.mdm.session.AbstractSessionCommand
              com.sap.mdm.session.AbstractUserSessionCommand
                  com.sap.mdm.data.commands.AbstractRetrieveLimitedRecordsCommand
                      com.sap.mdm.data.commands.RetrieveLimitedRecordsCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

RetrieveLimitedRecordsExCommand

public class RetrieveLimitedRecordsCommand

extends AbstractRetrieveLimitedRecordsCommand

A command for retrieving the list of limited records based on the search criteria.

Constructor Summary

RetrieveLimitedRecordsCommand(ConnectionAccessor connection)
Creates an instance.

RetrieveLimitedRecordsCommand(UserSessionContext ctx)
Creates a new instance of this command by context.

Method Summary

void	execute() Executes the command.
SortDefinition	getFieldSortingOrder() Deprecated. replaced by ResultDefinition.getFieldSortingOrder()
int	getPageIndex() Returns the paging index.
int	getPageSize() Returns the page size.
RecordResultSet	getRecords() Returns the record result set.
FieldId[]	getResultTablePath() Returns the result table path.
Search	getSearch() Returns the search criteria.
int	getSearchTableMatchCount() Returns the match count for the search table, based on the search criteria.
void	setFieldSortingOrder(SortDefinition fieldSorting) Deprecated. replaced by ResultDefinition.setFieldSortingOrder(SortDefinition)
void	setPageIndex(int pageIndex) Sets the paging index (optional).
void	setPageSize(int pageSize) Sets the page size (optional).
void	setResultTablePath(FieldId[] resultTablePath) Sets the result table path (optional).
void	setSearch(Search search) Sets the search criteria (required).

Methods inherited from class com.sap.mdm.data.commands.AbstractRetrieveLimitedRecordsCommand

getRegionalLayer, getResultDefinition, getSupportingResultDefinitions, setRegionalLayer, setResultDefinition, setSupportingResultDefinitions

Methods inherited from class com.sap.mdm.commands.AbstractCommand

getSession, setSession

Methods inherited from class com.sap.mdm.commands.AbstractCommandBase

isCommandComplete

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetrieveLimitedRecordsCommand

public RetrieveLimitedRecordsCommand(ConnectionAccessor connection)

Creates an instance.

Parameters:

connection - the connection to the MDM server

RetrieveLimitedRecordsCommand

public RetrieveLimitedRecordsCommand(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. The search criteria specifies the search table and what to search for.

Returns:

the search criteria

setSearch

public void setSearch(Search search)

Sets the search criteria (required). The search criteria specifies the search table and what to search for.

Parameters:

search - the search criteria

getResultTablePath

public FieldId[] getResultTablePath()

Returns the result table path. The result table path specifies the table to retrieve data from. It is specified by a list of fields. If the result table is the same as the search table, the list of field path is an empty list. Defaults to the search table.

Returns:

the result table path

setResultTablePath

public void setResultTablePath(FieldId[] resultTablePath)

Sets the result table path (optional). The result table path specifies the table to retrieve data from. It is specified by a list of fields. If the result table is the same as the search table, the list of field path is an empty list.

Parameters:

resultTablePath - the list of field Ids specifying the result table

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.

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.

Parameters:

pageSize - the page size

See Also:

setPageIndex(int)

getFieldSortingOrder

public SortDefinition getFieldSortingOrder()

Deprecated. replaced by ResultDefinition.getFieldSortingOrder()

Returns the field sorting order. The default is no sorting.

Returns:

the field sorting order

setFieldSortingOrder

public void setFieldSortingOrder(SortDefinition fieldSorting)

Deprecated. replaced by ResultDefinition.setFieldSortingOrder(SortDefinition)

Sets the field sorting order (optional). The default is no sorting.

Parameters:

fieldSorting - the field sorting order

getRecords

public RecordResultSet getRecords()

Returns the record result set.

Returns:

the record result set

execute

public void execute()
             throws CommandException

Description copied from interface: Command

Executes the command.

Specified by:

execute in interface Command

Overrides:

execute in class AbstractRetrieveLimitedRecordsCommand

Throws:

CommandException

getSearchTableMatchCount

public int getSearchTableMatchCount()

Returns the match count for the search table, based on the search criteria.

Returns:

the count