OrderGroupManager.FindTemplatesForUser Method (PIA)

  • Article

Use this method to build and return a Recordset of OrderGroup templates for the specified user.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders
…
Public Function FindTemplatesForUser(Optional UserId As String,
  Optional SearchDateTimeColumn As Object,
  Optional SearchDateTimeStart As Object,
  Optional SearchDateTimeEnd As Object,
  Optional JoinOrderFormInfo As Object,
  Optional JoinLineItemInfo As Object,
  Optional Columns As Object,
  Optional OrderGroupSortColumn As Object,
  Optional SortDirection As Object,
  Optional PageSize As Integer,
  Optional PageNumber As Integer,
  Optional outTotalRecordsFound As Object) As Object

[C#]

using Microsoft.CommerceServer.Interop.Orders;
using ADODB26Lib;                              //For Recordset
…
public object FindTemplatesForUser(stringUserId,
  objectSearchDateTimeColumn,
  objectSearchDateTimeStart,
  objectSearchDateTimeEnd,
  boolJoinOrderFormInfo,
  boolJoinLineItemInfo,
  objectColumns,
  objectOrderGroupSortColumn,
  objectSortDirection,
  intPageSize,
  intPageNumber,
  ref objectoutTotalRecordsFound);

Parameters

[Visual Basic .NET]

  • UserId
    A String that contains the User ID GUID.
  • SearchDateTimeColumn
    An Object that contains the DateTime column name to use in the search.
  • SearchDateTimeStart
    An Object that contains the search DateTime start value.
  • SearchDateTimeEnd
    An Object that contains the search DateTime end value.
  • JoinOrderFormInfo
    A Boolean that indicates whether the OrderFormHeader table is included in the search. A value of True indicates that the table is included. A value of False indicates that the table is not included.
  • JoinLineItemInfo
    A Boolean that indicates whether the OrderFormLineItem table is included in the search. A value of True indicates that the table is included. A value of False indicates that the table is not included.
  • Columns
    An Object that contains the names of columns that you want returned in addition to the default columns.
  • OrderGroupSortColumn
    An Object that contains the OrderGroup sort column.
  • SortDirection
    An Object that contains the sort direction.
  • PageSize
    An Integer that contains the page size.
  • PageNumber
    An Integer that contains the page number.
  • outTotalRecordsFound
    An Object that contains the total number of records found. This parameter is optional.

[C#]

  • UserId
    A string that contains the User ID GUID.
  • SearchDateTimeColumn
    An object that contains the DateTime column name to use in the search. Set to Type.Missing to not use a DateColumn search column.
  • SearchDateTimeStart
    An object that contains the search DateTime start value. Set to Type.Missing to not search using a start value.
  • SearchDateTimeEnd
    An object that contains the search DateTime end value. Set to Type.Missing to not search using an end value.
  • JoinOrderFormInfo
    A bool that indicates whether the OrderFormHeader table is included in the search. A value of true indicates that the table is included. A value of false indicates that the table is not included.
  • JoinLineItemInfo
    A bool that indicates whether the OrderFormLineItem table is included in the search. A value of true indicates that the table is included. A value of false indicates that the table is not included.
  • Columns
    An object that contains the names of columns that you want returned in addition to the default columns. Set to Type.Missing to include no additional columns.
  • OrderGroupSortColumn
    An object that contains the OrderGroup sort column. Set to Type.Missing to not specify an OrderGroup sort column.
  • SortDirection
    An object that contains the sort direction. Set to Type.Missing to not specify a sort direction.
  • PageSize
    An int that contains the page size. Set to Type.Missing to use the default value of 20.
  • PageNumber
    An int that contains the page number.
  • outTotalRecordsFound
    A reference to the object that contains the total number of records found. Set an 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 a Recordset of the search results.

[C#] This method returns an ADO Recordset of the search results.

Exceptions

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

' oOrderGroupManager is a Commerce OrderGroupManager object
oOrderGroupManager.FindTemplatesForUser("{11223344-1122-1122-1122- _
    AABBCCDDEEFF}")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

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

See Also

OrderGroupManager Class

Business Process Classs

Copyright © 2005 Microsoft Corporation.
All rights reserved.