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

This session provides methods to re-assign Results to Bilings. An Result may map to multiple Catalogues and removing the last reference to an Result is the equivalent of deleting it. Each Catalogue may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Result to another Catalogue is not a copy operation (eg: does not change its Id ).

MethodcanAssignResults
Description

Tests if this user can alter result/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignResultsToCatalogue
Description

Tests if this user can alter result/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT catalogueId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCatalogueIds
Description

Gets a list of catalogues including and under the given catalogue node in which any result can be assigned.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCatalogueIdsForResult
Description

Gets a list of catalogues including and under the given catalogue node in which a specific result can be assigned.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
osid.id.IdresultIdthe Id of the Result
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId or resultId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignResultToCatalogue
Description

Adds an existing Result to a Catalogue.

Parametersosid.id.IdresultIdthe Id of the Result
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsALREADY_EXISTS resultId already assigned to catalogueId
NOT_FOUND resultId or catalogueId not found
NULL_ARGUMENT resultId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignResultFromCatalogue
Description

Removes an Result from a Catalogue.

Parametersosid.id.IdresultIdthe Id of the Result
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsNOT_FOUND resultId or catalogueId not found or resultId not mapped to catalogueId
NULL_ARGUMENT resultId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.