Class CatalogMgr
Provides helper methods for getting categories.
Property Summary
Property Description siteCatalog : Catalog (read-only)Returns the catalog of the current site or null if no catalog is assigned to the site. sortingOptions : List (read-only)Returns a list containing the sorting options configured for this site. sortingRules : Collection (read-only)Returns a collection containing all of the sorting rules for this site, including global sorting rules.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Method Description static getCatalog (String ) Returns the catalog identified by the specified catalog id. static getCategory (String ) Returns the category of the site catalog identified by the specified category id. static getSiteCatalog () Returns the catalog of the current site or null if no catalog is assigned to the site. static getSortingOption (String ) Returns the sorting option with the given ID for this site, or null if there is no such option. static getSortingOptions () Returns a list containing the sorting options configured for this site. static getSortingRule (String ) Returns the sorting rule with the given ID for this site, or null if there is no such rule. static getSortingRules () Returns a collection containing all of the sorting rules for this site, including global sorting rules.
Methods inherited from class Object
assign , create , create , defineProperties , defineProperty , entries , freeze , fromEntries , getOwnPropertyDescriptor , getOwnPropertyNames , getOwnPropertySymbols , getPrototypeOf , hasOwnProperty , is , isExtensible , isFrozen , isPrototypeOf , isSealed , keys , preventExtensions , propertyIsEnumerable , seal , setPrototypeOf , toLocaleString , toString , valueOf , values
Property Details
siteCatalog
siteCatalog: Catalog (read-only)
Returns the catalog of the current site or null if no catalog is assigned to the site.
sortingOptions
sortingOptions: List (read-only)
Returns a list containing the sorting options configured for this site.
sortingRules
sortingRules: Collection (read-only)
Returns a collection containing all of the sorting rules for this site, including global sorting rules.
Method Details
getCatalog(String)
static getCatalog(id: String ): Catalog
Returns the catalog identified by the specified catalog id.
Returns null if no catalog with the specified id exists in the
current organization context.
Parameters:
Returns:
getCategory(String)
static getCategory(id: String ): Category
Returns the category of the site catalog identified by the specified
category id. Returns null if no site catalog is defined, or no category
with the specified id is found in the site catalog.
Parameters:
id - the category identifier.
Returns:
the category of the site catalog identified by the specified
category id or null if no site catalog is found.
getSiteCatalog()
static getSiteCatalog(): Catalog
Returns the catalog of the current site or null if no catalog is assigned to the site.
Returns:
the catalog of the current site or null.
getSortingOption(String)
static getSortingOption(id: String ): SortingOption
Returns the sorting option with the given ID for this site, or
null if there is no such option.
Parameters:
id - the ID of the sorting option
Returns:
getSortingOptions()
static getSortingOptions(): List
Returns a list containing the sorting options configured for this site.
Returns:
a list of SortingOption objects
getSortingRule(String)
static getSortingRule(id: String ): SortingRule
Returns the sorting rule with the given ID for this site,
or null if there is no such rule.
Parameters:
id - the ID of the sorting rule
Returns:
getSortingRules()
static getSortingRules(): Collection
Returns a collection containing all of the sorting rules for this site, including global sorting rules.
Returns:
a collection of SortingRule objects
j