OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerEnablerCatalogueSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve OfferingConstrainerEnabler to Catalogue mappings. An OfferingConstrainerEnabler may appear in multiple Catalogue objects. Each catalogue may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupOfferingConstrainerEnablerCatalogueMappings
Description

Tests if this user can perform lookups of offering constrainer enabler/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeOfferingConstrainerEnablerCatalogueView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryOfferingConstrainerEnablerCatalogueView
Description

A complete view of the OfferingConstrainerEnabler and Catalogue returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetOfferingConstrainerEnablerIdsByCatalogue
Description

Gets the list of OfferingConstrainerEnablerIds associated with a Catalogue.

Parametersosid.id.IdcatalogueId Id of the Catalogue
Returnosid.id.IdListlist of related offering constrainer enabler Ids
ErrorsNOT_FOUND catalogueId is not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablersByCatalogue
Description

Gets the list of offering constrainer enablers associated with a Catalogue.

Parametersosid.id.IdcatalogueId Id of the Catalogue
Returnosid.offering.rules.OfferingConstrainerEnablerListlist of related offering constrainer enablers
ErrorsNOT_FOUND catalogueId is not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerIdsByCatalogues
Description

Gets the list of OfferingConstrainerEnabler Ids corresponding to a list of Catalogues.

Parametersosid.id.IdListcatalogueIdslist of catalogue Ids
Returnosid.id.IdListlist of offering constrainer enabler Ids
ErrorsNULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablersByCatalogues
Description

Gets the list of offering constrainer enablers corresponding to a list of Catalogues.

Parametersosid.id.IdListcatalogueIdslist of catalogue Ids
Returnosid.offering.rules.OfferingConstrainerEnablerListlist of offering constrainer enablers
ErrorsNULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueIdsByOfferingConstrainerEnabler
Description

Gets the Catalogue Ids mapped to an OfferingConstrainerEnabler.

Parametersosid.id.IdofferingConstrainerEnablerId Id of an OfferingConstrainerEnabler
Returnosid.id.IdListlist of catalogues
ErrorsNOT_FOUND offeringConstrainerEnablerId is not found
NULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByOfferingConstrainerEnabler
Description

Gets the Catalogues mapped to an OfferingConstrainerEnabler.

Parametersosid.id.IdofferingConstrainerEnablerId Id of an OfferingConstrainerEnabler
Returnosid.offering.CatalogueListlist of catalogues
ErrorsNOT_FOUND offeringConstrainerEnablerId is not found
NULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.