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

This session provides methods to re-assign BrokerProcessorEnabler to Distributor mappings. A BrokerProcessorEnabler may appear in multiple Distributor objects and removing the last reference to a BrokerProcessorEnabler is the equivalent of deleting it. Each Distributor may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a BrokerProcessorEnabler to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignBrokerProcessorEnablers
Description

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

Tests if this user can alter broker processor enabler/distributor 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.IddistributorIdthe Id of the Distributor
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIds
Description

Gets a list of distributors including and under the given distributor node in which any broker processor enabler can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIdsForBrokerProcessorEnabler
Description

Gets a list of distributors including and under the given distributor node in which a specific broker processor enabler can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or brokerProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBrokerProcessorEnablerToDistributor
Description

Adds an existing BrokerProcessorEnabler to a Distributor.

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTS brokerProcessorEnablerId is already assigned to distributorId
NOT_FOUND brokerProcessorEnablerId or distributorId not found
NULL_ARGUMENT brokerProcessorEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBrokerProcessorEnablerFromDistributor
Description

Removes a BrokerProcessorEnabler from a Distributor.

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsNOT_FOUND brokerProcessorEnablerId or distributorId not found or brokerProcessorEnablerId not assigned to distributorId
NULL_ARGUMENT brokerProcessorEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.