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

This session provides methods to retrieve Result to Catalogue mappings. An Result 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
MethodcanLookupResultCatalogueMappings
Description

Tests if this user can perform lookups of result/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 Result 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.
MethodgetResultIdsByCatalogue
Description

Gets the list of Result Ids associated with a Catalogue.

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

Gets the list of Results associated with a Catalogue.

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

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

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

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

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

Gets the list of Catalogue Ids mapped to an Result.

Parametersosid.id.IdresultId Id of an Result
Returnosid.id.IdListlist of catalogue Ids
ErrorsNOT_FOUND resultId is not found
NULL_ARGUMENT resultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByResult
Description

Gets the list of Catalogue objects mapped to an Result.

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