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

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

MethodcanAssignCanonicalUnitProcessorEnablers
Description

Tests if this user can alter canonical unit processor 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.
MethodcanAssignCanonicalUnitProcessorEnablersToCatalogue
Description

Tests if this user can alter canonical unit processor 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 processor 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.
MethodgetAssignableCatalogueIdsForCanonicalUnitProcessorEnabler
Description

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

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
osid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId or canonicalUnitProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCanonicalUnitProcessorEnablerToCatalogue
Description

Adds an existing CanonicalUnitProcessorEnabler to a Catalogue.

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

Removes a CanonicalUnitProcessorEnabler from a Catalogue.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId or catalogueId not found or canonicalUnitProcessorEnablerId not assigned to catalogueId
NULL_ARGUMENT canonicalUnitProcessorEnablerId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCanonicalUnitProcessorEnablerToCatalogue
Description

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

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