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

This session provides methods to re-assign BrokerConstrainerEnabler to Distributor mappings. A BrokerConstrainerEnabler may appear in multiple Distributor objects and removing the last reference to a BrokerConstrainerEnabler 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 BrokerConstrainerEnabler to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignBrokerConstrainerEnablers
Description

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

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

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdbrokerConstrainerEnablerIdthe Id of the BrokerConstrainerEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or brokerConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBrokerConstrainerEnablerToDistributor
Description

Adds an existing BrokerConstrainerEnabler to a Distributor.

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

Removes a BrokerConstrainerEnabler from a Distributor.

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