Class sap.ui2.srvc.AllCatalogs

Defined in: allcatalogs.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	sap.ui2.srvc.AllCatalogs(oFactory, sPageId) Constructs a new representation (wrapper) for the given page's `allCatalogs` collection to be loaded from the given factory's page building service.

Method Summary
Method Attributes	Method Name and Description
	getCatalogs() Returns this collection's catalog instances.
	isStub() Tells whether this `allCatalogs` collection is still only a stub and does not yet know its individual catalogs.
	load(fnSuccess, fnFailure, sFilter, bPartially, sSorting) Loads this `allCatalogs` collection including all of its catalogs and their CHIPs.
	toString(bVerbose) Returns this `allCatalogs` collection's string representation.

Class Detail

sap.ui2.srvc.AllCatalogs(oFactory, sPageId)

Constructs a new representation (wrapper) for the given page's allCatalogs collection to be loaded from the given factory's page building service. Note that this collection does not contain the page's classic catalog as returned by sap.ui2.srvc.Page#getCatalog).

Parameters:

{sap.ui2.srvc.Factory} oFactory

the factory

{string} sPageId

ID of the page

Initially a stub is created, which can later load its properties and related objects asynchronously.

This collection and the contained catalogs are currently read-only and cannot be updated through the page building service. (see sap.ui2.srvc.PageBuildingService, sap.ui2.srvc.Catalog)

Since:: 1.7.0

Method Detail

{sap.ui2.srvc.Catalog[]} getCatalogs()

Returns this collection's catalog instances. Can only be called if the collection itself is not a stub anymore.

Since:: 1.7.0

Returns:: {sap.ui2.srvc.Catalog[]} this collection's catalog instances

See:: #isStub()

{boolean} isStub()

Tells whether this allCatalogs collection is still only a stub and does not yet know its individual catalogs.

Since:: 1.7.0

Returns:: {boolean} whether this allCatalogs collection is still only a stub

See:: #load()

load(fnSuccess, fnFailure, sFilter, bPartially, sSorting)

Loads this allCatalogs collection including all of its catalogs and their CHIPs. Notifies one of the given handlers.

Parameters:
{function ()} fnSuccess: no-args success handler
{function (string|[object])} fnFailure Optional: error handler taking an error message and, since version 1.28.6, an optional object containing the complete error information as delivered by the ODataService. See fnFailure parameter of sap.ui2.srvc.ODataWrapper#onError for more details. If not given, the default sap.ui2.srvc.ODataService#getDefaultErrorHandler is used
{string} sFilter Optional: filter value as defined by OData specification e.g. "type eq 'H'" for HANA catalogs. Filter has been introduced with version 1.16.2.
{boolean} bPartially Optional, Default: false: Whether to load the allCatalogs collection only partially instead of making sure that also remote catalogs are fully loaded (since 1.17.1). Note: Non-remote catalogs are not affected!
{string} sSorting: name of the field to be sorted on via $orderby as defined by OData specification. If not defined the dafault sorting would be on the field id (since 1.44)

Since:: 1.7.0

{string} toString(bVerbose)

Returns this allCatalogs collection's string representation.

Parameters:
{boolean} bVerbose Optional, Default: false: flag whether to show all properties

Since:: 1.7.0

Returns:: {string} this allCatalogs collection's string representation

Classes

Class sap.ui2.srvc.AllCatalogs