BatchServicesFindBatches Method |
Searches the system for
Batches matching the specified search criteria.
Namespace:
FactoryLogix.xTend.Production
Assembly:
FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax public PagedSearchResults<Batch> FindBatches(
Guid sessionId,
BatchSearchCriteria[] criteria,
BatchSortDirective[] sorting,
int pageSize,
int pageNumber
)
Public Function FindBatches (
sessionId As Guid,
criteria As BatchSearchCriteria(),
sorting As BatchSortDirective(),
pageSize As Integer,
pageNumber As Integer
) As PagedSearchResults(Of Batch)
public:
virtual PagedSearchResults<Batch^>^ FindBatches(
Guid sessionId,
array<BatchSearchCriteria^>^ criteria,
array<BatchSortDirective^>^ sorting,
int pageSize,
int pageNumber
) sealed
abstract FindBatches :
sessionId : Guid *
criteria : BatchSearchCriteria[] *
sorting : BatchSortDirective[] *
pageSize : int *
pageNumber : int -> PagedSearchResults<Batch>
override FindBatches :
sessionId : Guid *
criteria : BatchSearchCriteria[] *
sorting : BatchSortDirective[] *
pageSize : int *
pageNumber : int -> PagedSearchResults<Batch>
Parameters
- sessionId
- Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method. - criteria
- Type: FactoryLogix.xTend.DataObjectsBatchSearchCriteria
A list of BatchSearchCriteria objects representing the search parameters. - sorting
- Type: FactoryLogix.xTend.DataObjectsBatchSortDirective
A list of BatchSortDirective objects describing how the search results should be ordered. - pageSize
- Type: SystemInt32
The maximum number of records to be returned by each single call to this method. This parameter must fall within a range of 0 to a maximum value of 500. If a value of 0 or null is specified, the default page size of 20 will be used. - pageNumber
- Type: SystemInt32
The page number of the result set to be retrieved when the search results in a result set greater than the page size. By default, a value of 1 will be used if this parameter is null or 0. A value of -1 indicates that the last page is desired.
Return Value
Type:
PagedSearchResultsBatchA
PagedSearchResultsT object containing 1 page worth of search results, where T is of type
Batch. If the result set of the search is greater than the page size, the return object contains the total number of pages which may be used by subsequent calls to retrieve more pages worth of result data.
Exceptions See Also