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

This session provides methods to apply CanonicalUnitProcessorEnablers to CanonicalUnitProcessors. A CanonicalUnitProcessor with multiple CanonicalUnitProcessorEnablers means any positive rule evaluation across the enablers result in an effective CanonicalUnitProcessor.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignCanonicalUnitProcessorEnablers
Description

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

Adds an existing CanonicalUnitProcessorEnabler to a CanonicalUnitProcessor.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler
osid.id.IdcanonicalUnitProcessorIdthe Id of the CanonicalUnitProcessor
ErrorsALREADY_EXISTS canonicalUnitProcessorEnablerId already applied to canonicalUnitProcessorId
NOT_FOUND canonicalUnitProcessorEnablerId or canonicalUnitProcessorId not found
NULL_ARGUMENT canonicalUnitProcessorEnablerId or canonicalUnitProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor
Description

Removes a CanonicalUnitProcessorEnabler from a CanonicalUnitProcessor.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler
osid.id.IdcanonicalUnitProcessorIdthe Id of the CanonicalUnitProcessor
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId or canonicalUnitProcessorId not found or not mapped
NULL_ARGUMENT canonicalUnitProcessorEnablerId or canonicalUnitProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceCanonicalUnitProcessorEnablers
Description

Tests if this user can order CanonicalUnitProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if CanonicalUnitProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveCanonicalUnitProcessorEnablerAhead
Description

Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler in front of a reference canonical unit processor enabler.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of a CanonicalUnitProcessorEnabler
osid.id.IdcanonicalUnitProcessorIdthe Id of a CanonicalUnitProcessor
osid.id.IdreferenceIdthe reference canonical unit processor Id
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId, canonicalUnitProcesorId, or referenceId not found or, canonicalUnitProcessorEnablerId or referenceId not related to canonicalUnitProcessorId
NULL_ARGUMENT canonicalUnitProcessorEnablerId, canonicalUnitProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveCanonicalUnitProcessorEnablerBehind
Description

Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler behind a reference canonical unit processor enabler.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of a CanonicalUnitProcessorEnabler
osid.id.IdcanonicalUnitProcessorIdthe Id of a CanonicalUnitProcessor
osid.id.IdreferenceIdthe reference canonical unit processor Id
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId, canonicalUnitProcesorId, or referenceId not found or, canonicalUnitProcessorEnablerId or referenceId not related to canonicalUnitProcessorId
NULL_ARGUMENT canonicalUnitProcessorEnablerId, canonicalUnitProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderCanonicalUnitProcessorEnablers
Description

Reorders a set of canonical unit processor enablers for a canonical unit processor.

Parametersosid.id.Id[]canonicalUnitProcessorEnablerIdsthe Ids for a set of CanonicalUnitProcessorEnablers
osid.id.IdcanonicalUnitProcessorIdthe Id of a CanonicalUnitProcessor
ErrorsNOT_FOUND canonicalUnitProcessorId not found or, a canonicalUnitProcessorEnablerId not related to canonicalUnitProcessorId
NULL_ARGUMENT canonicalUnitProcessorEnablerIds or canonicalUnitProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.