OrderGroupManager.Find Method (PIA)

Use this method to perform an SQL search based on the specified SQL clause fragments.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders
…
Public Function Find(OrderGroupCriteriaArray As Object,
  OrderFormCriteriaArray As Object,
  LineItemCriteriaArray As Object,
  Optional SearchDateTimeColumn As Object,
  Optional SearchDateTimeStart As Object,
  Optional SearchDateTimeEnd As Object,
  Optional StatusFilter As Integer,
  Optional JoinOrderFormInfo As Boolean,
  Optional JoinLineItemInfo As Boolean,
  Optional Columns As Object,
  Optional OrderGroupSortColumn As Object,
  Optional SortDirection As Object,
  Optional PageSize As Integer,
  Optional PageNumber As Integer,
  Optional ByRef outTotalRecordsFound As Object) As Object

[C#]

using Microsoft.CommerceServer.Interop.Orders;
using ADODB26Lib;                              //For Recordset
…
public object Find(object OrderGroupCriteriaArray,
  object OrderFormCriteriaArray,
  object LineItemCriteriaArray,
  object SearchDateTimeColumn,
  object SearchDateTimeStart,
  object SearchDateTimeEnd,
  intStatusFilter,
  boolboolJoinOrderFormInfo,
  boolboolJoinLineItemInfo,
  object Columns,
  object OrderGroupSortColumn,
  object SortDirection,
  intPageSize,
  intPageNumber,
  ref objectoutTotalRecordsFound);

Parameters

[Visual Basic .NET]

  • OrderGroupCriteriaArray
    An Object that contains the SQL clause used to search for a specific set of OrderGroup objects.
  • OrderFormCriteriaArray
    An Object that contains the SQL clause used to search for a specific set of OrderForm objects.
  • LineItemCriteriaArray
    An Object that contains the SQL clause used to search for a specific set of line items.
  • SearchDateTimeColumn
    An Object that specifies the DateTime column name to search for; if left null, the DateTime column name does not become part of the search criteria. This parameter is optional.
  • SearchDateTimeStart
    An Object that specifies the DateTime start value to search for; if left null, the DateTime start value does not become part of the search criteria. This parameter is optional.
  • SearchDateTimeEnd
    An Object that specifies the DateTime end value to search for; if left null, the DateTime end value does not become part of the search criteria. This parameter is optional.
  • StatusFilter
    An Integer that stores the OrderGroup object status. This parameter is optional.
  • JoinOrderFormInfo
    A Boolean indicating whether to include the OrderFormHeader table in the results. This parameter is optional.
  • JoinLineItemInfo
    A Boolean indicating whether to include the OrderFormLineItems table in the results. This parameter is optional.
  • Columns
    An Object that contains the names of the columns to return in addition to the default columns. This parameter is optional.
  • OrderGroupSortColumn
    An Object that contains the OrderGroup column name to sort on. This parameter is optional.
  • SortDirection
    An Object that contains the sort direction. This parameter is optional; possible values for this parameter are the SQL strings "ASC" or "DESC".
  • PageSize
    With this method, you can implement a paging mechanism that allows you to page through your orders. (These could be viewed in a list sheet, for example.) The PageSize parameter is an Integer that contains the number of line items per page. This parameter setting must be coordinated with the PageNumber parameter. This parameter is optional and has a default value of 20.
  • PageNumber
    With this method, you can implement a paging mechanism that allows you to page through your orders. (These could be viewed in a list sheet, for example.) The PageNumber parameter is an Integer that contains the page number to jump to. This parameter setting must be coordinated with the PageSize parameter. This parameter is optional.
  • outTotalRecordsFound
    An Object that specifies the total number of records found.

[C#]

  • OrderGroupCriteriaArray
    An object that contains the SQL clause used to search for a specific set of OrderGroup objects.
  • OrderFormCriteriaArray
    An object that contains the SQL clause used to search for a specific set of OrderForm objects.
  • LineItemCriteriaArray
    An object that contains the SQL clause used to search for a specific set of line items.
  • SearchDateTimeColumn
    An object that specifies the DateTime column name to search for; if set to Type.Missing, the DateTime column name does not become part of the search criteria.
  • SearchDateTimeStart
    An object that specifies the DateTime start value to search for; if set to Type.Missing, the DateTime start value does not become part of the search criteria.
  • SearchDateTimeEnd
    An object that specifies the DateTime end value to search for; if set to Type.Missing, the DateTime end value does not become part of the search criteria.
  • StatusFilter
    An int that stores the OrderGroup status. Set to 0 for default.
  • JoinOrderFormInfo
    A bool indicating whether to include the OrderFormHeader table in the results.
  • JoinLineItemInfo
    A bool indicating whether to include the OrderFormLineItems table in the results.
  • Columns
    An object that contains the names of the columns to return in addition to the default columns. Set to Type.Missing to return no additional columns.
  • OrderGroupSortColumn
    An object that contains the OrderGroup column name to sort on. Set to Type.Missing in order to not specify a sort column.
  • SortDirection
    An object that contains the sort direction. This parameter is optional; possible values for this parameter are the SQL strings "ASC" or "DESC". Set to Type.Missing in order to not specify a sort direction.
  • PageSize
    With this method, you can implement a paging mechanism that allows you to page through your orders. (These could be viewed in a list sheet, for example.) The PageSize parameter is an int that contains the number of line items per page. This parameter setting must be coordinated with the PageNumber parameter. Set to Type.Missing to use the default value of 20.
  • PageNumber
    With this method, you can implement a paging mechanism that allows you to page through your orders. (These could be viewed in a list sheet, for example.) The PageNumber parameter is an int that contains the page number to jump to. This parameter setting must be coordinated with the PageSize parameter. Set to Type.Missing to use the default value of 1.
  • outTotalRecordsFound
    A reference to an object that specifies the total number of records found. Set the object to Type.Missing if the returned value is not needed.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Object that contains the Recordset containing the result set that meets the search criteria.

[C#] This method returns an ADODB26Lib.Recordset containing the result set that meets the search criteria.

Exceptions

[Visual Basic .NET] This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

[Visual Basic .NET]

Example

' oRecordset is an Object
' oOrderGroupCriteriaArray is an Object
' oOrderFormCriteriaArray is an Object
' oLineItemCriteriaArray is an Object
' oOrderGroupManager is a Commerce OrderGroupManager object
oRecordset = oOrderGroupManager.Find(oOrderGroupCriteriaArray, _
    oOrderFormCriteriaArray, oLineItemCriteriaArray)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Interop.Orders.Requisition.dll

OrderGroupManager Class

OrderGroupManager.SimpleFind

Copyright © 2005 Microsoft Corporation.
All rights reserved.