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

This session provides methods to apply BrokerProcessors to Brokers.

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.
MethodcanAssignBrokerProcessors
Description

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

Adds an existing BrokerProcessor to a Broker.

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

Removes a BrokerProcessor from a Broker.

Parametersosid.id.IdbrokerProcessorIdthe Id of the BrokerProcessor
osid.id.IdbrokerIdthe Id of the Broker
ErrorsNOT_FOUND brokerProcessorId or brokerId not found or brokerProcessorId not applied to brokerId
NULL_ARGUMENT brokerProcessorId or brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceBrokerProcessors
Description

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

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

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

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

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

Reorders a set of broker processors for a broker.

Parametersosid.id.Id[]brokerProcessorIdsthe Ids for a set of BrokerProcessors
osid.id.IdbrokerIdthe Id of a Broker
ErrorsNOT_FOUND brokerId not found or, a brokerProcessorId not related to brokerId
NULL_ARGUMENT brokerProcessorIds or brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.