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

This session provides methods to retrieve Offering to Catalogue mappings. An Offering may appear in multiple Catalogues. 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
MethodcanLookupOfferingCatalogueMappings
Description

Tests if this user can perform lookups of offering/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 intendedas 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.
MethoduseComparativeCatalogueView
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.
MethodusePlenaryCatalogueView
Description

A complete view of the Offering 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.
MethodgetOfferingIdsByCatalogue
Description

Gets the list of Offering Ids associated with a Catalogue.

Parametersosid.id.IdcatalogueId Id of a Catalogues.
Returnosid.id.IdListlist of related offering 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.
MethodgetOfferingsByCatalogue
Description

Gets the list of Offerings associated with a Catalogue.

Parametersosid.id.IdcatalogueId Id of a Catalogue
Returnosid.offering.OfferingListlist of related offerings
ErrorsNOT_FOUND catalogueId is not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfferingIdsByCatalogues
Description

Gets the list of Offering Ids corresponding to a list of Catalogue objects.

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

Gets the list of Offerings corresponding to a list of Catalogues.

Parametersosid.id.IdListcatalogueIdslist of catalogue Ids
Returnosid.offering.OfferingListlist of offerings
ErrorsNULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueIdsByOffering
Description

Gets the list of Catalogue Ids mapped to an Offering.

Parametersosid.id.IdofferingId Id of an Offering
Returnosid.id.IdListlist of catalogue Ids
ErrorsNOT_FOUND offeringId is not found
NULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByOffering
Description

Gets the list of Catalogue objects mapped to an Offering.

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