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

This session provides methods to re-assign CanonicalUnitEnabler to Catalogue mappings. A CanonicalUnitEnabler may appear in multiple Catalogue objects and removing the last reference to a CanonicalUnitEnabler 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 a CanonicalUnitEnabler to another Catalogue is not a copy operation (eg: does not change its Id ).

MethodcanAssignCanonicalUnitEnablers
Description

Tests if this user can alter canonical unit enabler/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.
MethodcanAssignCanonicalUnitEnablersToCatalogue
Description

Tests if this user can alter canonical unit enabler/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.

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 canonical unit enabler 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.
MethodgetAssignableCatalogueIdsForCanonicalUnitEnabler
Description

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

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
osid.id.IdcanonicalUnitEnablerIdthe Id of the CanonicalUnitEnabler
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId or canonicalUnitEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCanonicalUnitEnablerToCatalogue
Description

Adds an existing CanonicalUnitEnabler to a Catalogue.

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

Removes a CanonicalUnitEnabler from a Catalogue.

Parametersosid.id.IdcanonicalUnitEnablerIdthe Id of the CanonicalUnitEnabler
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsNOT_FOUND canonicalUnitEnablerId or catalogueId not found or canonicalUnitEnablerId already assigned to catalogueId
NULL_ARGUMENT canonicalUnitEnablerId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCanonicalUnitEnablerToCatalogue
Description

Moves a CanonicalUnitEnablerr from one Catalogue to another. Mappings to other Catalogues are unaffected.

Parametersosid.id.IdcanonicalUnitEnablerIdthe Id of the CanonicalUnitEnabler
osid.id.IdfromCatalogueIdthe Id of the current Catalogue
osid.id.IdtoCatalogueIdthe Id of the destination Catalogue
ErrorsNOT_FOUND canonicalUnitEnablerId, fromCatalogueId, or toCatalogueId not found or canonicalUnitEnablerId, not mapped to fromCatalogueId
NULL_ARGUMENT canonicalUnitEnablerId, fromCatalogueId, or toCatalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.