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

This session provides methods to apply BrokerConstrainers to Brokers. A Broker with multiple BrokerConstrainers means any positive rule evaluation across the result in an effective Broker.

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

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

Adds an existing BrokerConstrainer to a Broker.

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

Removes a BrokerConstrainer from a Broker.

Parametersosid.id.IdbrokerConstrainerIdthe Id of the BrokerConstrainer
osid.id.IdbrokerIdthe Id of the Broker
ErrorsNOT_FOUND brokerConstrainerId or brokerId not found or brokerConstrainerId not applied to brokerId
NULL_ARGUMENT brokerConstrainerId or brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceBrokerConstrainers
Description

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

Reorders broker constrainers for a broker by moving the specified broker constrainer in front of a reference broker.

Parametersosid.id.IdbrokerConstrainerIdthe Id of a BrokerConstrainer
osid.id.IdbrokerIdthe Id of a Broker
osid.id.IdreferenceIdthe reference broker constrainer Id
ErrorsNOT_FOUND brokerConstrainerId, brokerId, or referenceId not found or, brokerConstrainerId or referenceId not related to brokerId
NULL_ARGUMENT brokerConstrainerId, brokerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveBrokerConstrainerBehind
Description

Reorders broker constrainers for a broker by moving the specified broker constrainer behind a reference broker.

Parametersosid.id.IdbrokerConstrainerIdthe Id of a BrokerConstrainer
osid.id.IdbrokerIdthe Id of a Broker
osid.id.IdreferenceIdthe reference broker constrainer Id
ErrorsNOT_FOUND brokerConstrainerId, brokerId, or referenceId not found or, brokerConstrainerId or referenceId not related to brokerId
NULL_ARGUMENT brokerConstrainerId, brokerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderBrokerConstrainers
Description

Reorders a set of broker constrainers for a broker.

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