OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorEnablerRuleApplicationSession
Implementsosid.OsidSession
Description

This session provides methods to apply BrokerProcessorEnablers to BrokerProcessors. A BrokerProcessor with multiple BrokerProcessorEnablers means any positive rule evaluation across the enablers result in an effective BrokerProcessor.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignBrokerProcessorEnablers
Description

Tests if this user can alter broker processor enabler/broker 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.
MethodassignBrokerProcessorEnablerToBrokerProcessor
Description

Adds an existing BrokerProcessorEnabler to a BrokerProcessor.

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
osid.id.IdbrokerProcessorIdthe Id of the BrokerProcessor
ErrorsALREADY_EXISTS brokerProcessorEnablerId is already applied to brokerProcessorId
NOT_FOUND brokerProcessorEnablerId or brokerProcessorId not found
NULL_ARGUMENT brokerProcessorEnablerId or brokerProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBrokerProcessorEnablerFromBrokerProcessor
Description

Removes a BrokerProcessorEnabler from a BrokerProcessor.

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
osid.id.IdbrokerProcessorIdthe Id of the BrokerProcessor
ErrorsNOT_FOUND brokerProcessorEnablerId or brokerProcessorId not found or brokerProcessorEnablerId not applied to brokerProcessorId
NULL_ARGUMENT brokerProcessorEnablerId or brokerProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceBrokerProcessorEnablers
Description

Tests if this user can order BrokerProcessorEnablers. 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 BrokerProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveBrokerProcessorEnablerAhead
Description

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

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of a BrokerProcessorEnabler
osid.id.IdbrokerProcessorIdthe Id of a BrokerProcessor
osid.id.IdreferenceIdthe reference broker processor enabler Id
ErrorsNOT_FOUND brokerProcessorEnablerId, brokerProcessorId, or referenceId not found or, brokerProcessorEnablerId or referenceId not related to brokerProcessorId
NULL_ARGUMENT brokerProcessorEnablerId, brokerProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveBrokerProcessorEnablerBehind
Description

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

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of a BrokerProcessorEnabler
osid.id.IdbrokerProcessorIdthe Id of a BrokerProcessor
osid.id.IdreferenceIdthe reference broker processor enabler Id
ErrorsNOT_FOUND brokerProcessorEnablerId, brokerProcessorId, or referenceId not found or, brokerProcessorEnablerId or referenceId not related to brokerProcessorId
NULL_ARGUMENT brokerProcessorEnablerId, brokerProcessorId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderBrokerProcessorEnablers
Description

Reorders a set of broker processor enablers for a broker processor.

Parametersosid.id.Id[]brokerProcessorEnablerIdsthe Ids for a set of BrokerProcessorEnablers
osid.id.IdbrokerProcessorIdthe Id of a BrokerProcessor
ErrorsNOT_FOUND brokerProcessorId not found or, a brokerProcessorEnablerId not related to brokerProcessorId
NULL_ARGUMENT brokerProcessorEnablerIds or brokerProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.