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

This session provides methods for retrieving Catalogue objects. The Catalogue represents a collection of CanonicalUnits.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

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

Returnboolean false if lookup methods are 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 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.
MethodgetCatalogue
Description

Gets the Catalogue specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Catalogue may have a different Id than requested, such as the case where a duplicate Id was assigned to a Catalogue and retained for compatibility.

Parametersosid.id.IdcatalogueId Id of the Catalogue
Returnosid.offering.Cataloguethe catalogue
ErrorsNOT_FOUND catalogueId not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCataloguesByIds
Description

Gets a CatalogueList corresponding to the given IdList. In plenary mode, the returned list contains all of the catalogues specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Catalogues may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcatalogueIdsthe list of Ids to retrieve
Returnosid.offering.CatalogueListthe returned Catalogue list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByGenusType
Description

Gets a CatalogueList corresponding to the given catalogue genus Type which does not include catalogues of genus types derived from the specified Type. In plenary mode, the returned list contains all known catalogues or an error results. Otherwise, the returned list may contain only those catalogues that are accessible through this session.

Parametersosid.type.TypecatalogueGenusTypea catalogue genus type
Returnosid.offering.CatalogueListthe returned Catalogue list
ErrorsNULL_ARGUMENT catalogueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByParentGenusType
Description

Gets a CatalogueList corresponding to the given catalogue genus Type and include any additional catalogues with genus types derived from the specified Type. In plenary mode, the returned list contains all known catalogues or an error results. Otherwise, the returned list may contain only those catalogues that are accessible through this session.

Parametersosid.type.TypecatalogueGenusTypea catalogue genus type
Returnosid.offering.CatalogueListthe returned Catalogue list
ErrorsNULL_ARGUMENT catalogueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByRecordType
Description

Gets a CatalogueList containing the given catalogue record Type. In plenary mode, the returned list contains all known catalogues or an error results. Otherwise, the returned list may contain only those catalogues that are accessible through this session.

Parametersosid.type.TypecatalogueRecordTypea catalogue record type
Returnosid.offering.CatalogueListthe returned Catalogue list
ErrorsNULL_ARGUMENT catalogueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByProvider
Description

Gets a CatalogueList for the given provider. In plenary mode, the returned list contains all known catalogues or an error results. Otherwise, the returned list may contain only those catalogues that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.offering.CatalogueListthe returned Catalogue list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCatalogues
Description

Gets all Catalogues. In plenary mode, the returned list contains all known catalogues or an error results. Otherwise, the returned list may contain only those catalogues that are accessible through this session.

Returnosid.offering.CatalogueLista list of Catalogues
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.