OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.BrokerConstrainerEnablerDistributorAssignmentSession
Implementsosid.OsidSession
Used Byosid.provisioning.rules.ProvisioningRulesManager
osid.provisioning.rules.ProvisioningRulesProxyManager
Description

This session provides methods to re-assign BrokerConstrainerEnabler to Distributor mappings. A BrokerConstrainerEnabler may appear in multiple Distributor catalogs 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignBrokerConstrainerEnablerToDistributor
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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTdistributorId 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_ARGUMENTdistributorId 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_ARGUMENTdistributorId 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_EXISTSbrokerConstrainerEnablerId is already assigned to distributorId
NOT_FOUNDbrokerConstrainerEnablerId or distributorId not found
NULL_ARGUMENTbrokerConstrainerEnablerId 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 BrokerConstraienrEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsNOT_FOUNDbrokerConstrainerEnablerId or distributorId not found or brokerConstrainerEnablerId not assigned to distributorId
NULL_ARGUMENTbrokerConstrainerEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignBrokerConstrainerEnablerToDistributor
Description

Moves a BrokerConstrainerEnabler from one Distributor to another. Mappings to other Distributors are unaffected.

Parametersosid.id.IdbrokerConstrainerEnablerIdthe Id of the BrokerConstrainerEnabler
osid.id.IdfromDistributorIdthe Id of the current Distributor
osid.id.IdtoDistributorIdthe Id of the destination Distributor
ErrorsALREADY_EXISTSbrokerConstrainerEnablerId already assigned to toDistributorId
NOT_FOUNDbrokerConstrainerEnablerId, fromDistributorId , or toDistributorId not found or brokerConstrainerEnablerId not mapped to fromDistributorId
NULL_ARGUMENTbrokerConstrainerEnablerId, fromDistributorId , or toDistributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.