Interface CustomerSearch

Represents a search context for customers.

interface CustomerSearch {
    ExceptRole: ((roleSystemname: string, param?: SearchParam) => CustomerSearch);
    GetAllDetailed: (() => PagedList<Customer>);
    IncludeInactive: (() => CustomerSearch);
    InDepartment: (() => CustomerSearch);
    InEmail: ((email: string, param?: SearchParam) => CustomerSearch);
    InExternalId: ((externalId: string, param?: SearchParam) => CustomerSearch);
    InFirstName: ((firstName: string, param?: SearchParam) => CustomerSearch);
    InLastName: ((lastName: string, param?: SearchParam) => CustomerSearch);
    InRole: ((roleSystemname: string, param?: SearchParam) => CustomerSearch);
    InUsername: ((username: string, param?: SearchParam) => CustomerSearch);
    LoadAll: (() => CustomerSearch);
    LoadDepartment: (() => CustomerSearch);
    LoadEmail: (() => CustomerSearch);
    LoadUsername: (() => CustomerSearch);
    SetPageIndex: ((pageIndex: number) => CustomerSearch);
    SetPageSize: ((pageSize: number) => CustomerSearch);
    WithAttribute: ((attributeName: string, value: string, param?: SearchParam) => CustomerSearch);
}

Index

Properties

ExceptRole GetAllDetailed IncludeInactive InDepartment InEmail InExternalId InFirstName InLastName InRole InUsername LoadAll LoadDepartment LoadEmail LoadUsername SetPageIndex SetPageSize WithAttribute

Properties

ExceptRole

ExceptRole: ((roleSystemname: string, param?: SearchParam) => CustomerSearch)

Excludes customers by role in the search context.

Type declaration

- (roleSystemname, param?): CustomerSearch
- Parameters
  - roleSystemname: string
    The system name of the role to exclude.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

GetAllDetailed

GetAllDetailed: (() => PagedList<Customer>)

Loads all customers with detailed information.

IncludeInactive

IncludeInactive: (() => CustomerSearch)

Includes inactive customers in the search context.

InDepartment

InDepartment: (() => CustomerSearch)

Filters customers by department in the search context.

InEmail

InEmail: ((email: string, param?: SearchParam) => CustomerSearch)

Filters customers by email address in the search context.

Type declaration

- (email, param?): CustomerSearch
- Parameters
  - email: string
    The email address to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

InExternalId

InExternalId: ((externalId: string, param?: SearchParam) => CustomerSearch)

Filters customers by external ID in the search context.

Type declaration

- (externalId, param?): CustomerSearch
- Parameters
  - externalId: string
    The external ID to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

InFirstName

InFirstName: ((firstName: string, param?: SearchParam) => CustomerSearch)

Filters customers by first name in the search context.

Type declaration

- (firstName, param?): CustomerSearch
- Parameters
  - firstName: string
    The first name to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

InLastName

InLastName: ((lastName: string, param?: SearchParam) => CustomerSearch)

Filters customers by last name in the search context.

Type declaration

- (lastName, param?): CustomerSearch
- Parameters
  - lastName: string
    The last name to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

InRole

InRole: ((roleSystemname: string, param?: SearchParam) => CustomerSearch)

Filters customers by role in the search context.

Type declaration

- (roleSystemname, param?): CustomerSearch
- Parameters
  - roleSystemname: string
    The system name of the role to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

InUsername

InUsername: ((username: string, param?: SearchParam) => CustomerSearch)

Filters customers by username in the search context.

Type declaration

- (username, param?): CustomerSearch
- Parameters
  - username: string
    The username to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

LoadAll

LoadAll: (() => CustomerSearch)

Loads all customers in the search context.

LoadDepartment

LoadDepartment: (() => CustomerSearch)

Loads customers by department in the search context.

LoadEmail

LoadEmail: (() => CustomerSearch)

Loads customers by email address in the search context.

LoadUsername

LoadUsername: (() => CustomerSearch)

Loads customers by username in the search context.

SetPageIndex

SetPageIndex: ((pageIndex: number) => CustomerSearch)

Sets the page index for pagination in the search context.

Type declaration

- (pageIndex): CustomerSearch
- Parameters
  - pageIndex: number
    The page index to set.
  Returns CustomerSearch

SetPageSize

SetPageSize: ((pageSize: number) => CustomerSearch)

Sets the page size for pagination in the search context.

Type declaration

- (pageSize): CustomerSearch
- Parameters
  - pageSize: number
    The page size to set.
  Returns CustomerSearch

WithAttribute

WithAttribute: ((attributeName: string, value: string, param?: SearchParam) => CustomerSearch)

Filters customers by attribute in the search context.

Type declaration

- (attributeName, value, param?): CustomerSearch
- Parameters
  - attributeName: string
    The name of the attribute to filter by.
  - value: string
    The value of the attribute to filter by.
  - Optionalparam: SearchParam
    Optional search parameter.
  Returns CustomerSearch

Interface CustomerSearch

Index

Properties

Properties

ExceptRole

Type declaration

Parameters

Returns CustomerSearch

GetAllDetailed

IncludeInactive

InDepartment

InEmail

Type declaration

Parameters

Returns CustomerSearch

InExternalId

Type declaration

Parameters

Returns CustomerSearch

InFirstName

Type declaration

Parameters

Returns CustomerSearch

InLastName

Type declaration

Parameters

Returns CustomerSearch

InRole

Type declaration

Parameters

Returns CustomerSearch

InUsername

Type declaration

Parameters

Returns CustomerSearch

LoadAll

LoadDepartment

LoadEmail

LoadUsername

SetPageIndex

Type declaration

Parameters

Returns CustomerSearch

SetPageSize

Type declaration

Parameters

Returns CustomerSearch

WithAttribute

Type declaration

Parameters

Returns CustomerSearch

Settings

On This Page