Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • GetCatalogsInput

Index

Constructors

constructor

Properties

anonymousSiteUrl

anonymousSiteUrl: string = ""

apiNamespace

apiNamespace: string = ""

API Namespace to be used in Rest API call. e.g. h_cpq_promotion

cartId

cartId: string

The cart Id to be used as ContextId in the associated API to get list of catalogs. It may be the regular cart id or the anonymous cart id.

Optional catalogId

catalogId: string

Parent catalog ID. If this is provided, it will find only the child catalogs for this given catalog ID.

Optional fields

fields: string[]

List of fields to be returned. Not Supported yet.

Optional hierarchy

hierarchy: number

The hierarchy level to be retrieved. For only the current level of catalogs, hierarchy will be 0. For retrieving current level of catalogs with children, hierarchy will be 1.

Optional offset

offset: number

The offset to start the catalog list from. If we are using pagesize of 20, the offset for next page will be 21.

Optional pageSize

pageSize: number

The number of top level catalogs to be returned. Default is 20.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class to handle get products.

remoteMethod

remoteMethod: string = "getCatalogHierarchy"

Remote method in the boave Remote Class to handle get products.

Optional sortBy

sortBy: string[]

Sort the catalogs by the given sortBy

todo

need to chagne this to an object e.g. { Name:DESC,Description:ASC } This will sort the returned catalogs first by Name in descending order, then description in ascending order.

Static Private CustomProcessQueryNames

CustomProcessQueryNames: Set<string> = ...

Query Names that needs custom processing. These query names will be flattened out in URL Get parameters.

Methods

anonymousRestUrl

  • anonymousRestUrl(urlparams: any): string

getAnonymousRestUrl

  • getAnonymousRestUrl(params: object): string
  • Apply the given params value of matching in rest URL.

    Parameters

    • params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

getLoginUserRestPath

  • getLoginUserRestPath(params: object): string
  • Apply the given params value of matching in rest path.

    Parameters

    • params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

inputMap

  • inputMap(): object
  • Returns object

loginUserRestPath

  • loginUserRestPath(urlparams: any): string
  • Rest URL for login user to get products.

    Parameters

    • urlparams: any

    Returns string

urlEncodedQuery

  • urlEncodedQuery(): string
  • Return the encoded query of a URI that contains the properties in this class. Undefined properties will not be included in the encoded query.

    scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]

    Returns string

Generated using TypeDoc