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

This session creates and removes broker constrainer enablers. The data for create and update is provided via the BrokerConstrainerEnablerForm.

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

Tests if this user can create broker constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known a BrokerConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if BrokerConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateBrokerConstrainerEnablerWithRecordTypes
Description

Tests if this user can create a single BrokerConstrainerEnabler using the desired record types. While ProvisioningRulesManager.getBrokerConstrainerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific BrokerConstrainerEnabler. Providing an empty array tests if a BrokerConstrainerEnabler can be created with no records.

Parametersosid.type.Type[]brokerConstrainerEnablerRecordTypesarray of broker constrainer enabler record types
Returnboolean true if BrokerConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT brokerConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablerFormForCreate
Description

Gets the broker constrainer enabler form for creating new broker constrainer enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]brokerConstrainerEnablerRecordTypesarray of broker constrainer enabler record types
Returnosid.provisioning.rules.BrokerConstrainerEnablerFormthe broker constrainer enabler form
ErrorsNULL_ARGUMENT brokerConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateBrokerConstrainerEnabler
Description

Creates a new BrokerConstrainerEnabler.

Parametersosid.provisioning.rules.BrokerConstrainerEnablerFormbrokerConstrainerEnablerFormthe form for this BrokerConstrainerEnabler
Returnosid.provisioning.rules.BrokerConstrainerEnablerthe new BrokerConstrainerEnabler
ErrorsILLEGAL_STATE brokerConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT brokerConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerConstrainerEnablerForm did not originate from getBrokerConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateBrokerConstrainerEnablers
Description

Tests if this user can update broker constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a BrokerConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if BrokerConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablerFormForUpdate
Description

Gets the broker constrainer enabler form for updating an existing broker constrainer enabler. A new broker constrainer enabler form should be requested for each update transaction.

Parametersosid.id.IdbrokerConstrainerEnablerIdthe Id of the BrokerConstrainerEnabler
Returnosid.provisioning.rules.BrokerConstrainerEnablerFormthe broker constrainer enabler form
ErrorsNOT_FOUND brokerConstrainerEnablerId is not found
NULL_ARGUMENT brokerConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBrokerConstrainerEnabler
Description

Updates an existing broker constrainer enabler.

Parametersosid.provisioning.rules.BrokerConstrainerEnablerFormbrokerConstrainerEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE brokerConstrainerEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT brokerConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerConstrainerEnablerForm did not originate from getBrokerConstrainerEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteBrokerConstrainerEnablers
Description

Tests if this user can delete broker constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a BrokerConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if BrokerConstrainerEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteBrokerConstrainerEnabler
Description

Deletes a BrokerConstrainerEnabler.

Parametersosid.id.IdbrokerConstrainerEnablerIdthe Id of the BrokerConstrainerEnabler to remove
ErrorsNOT_FOUND brokerConstrainerEnablerId not found
NULL_ARGUMENT brokerConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageBrokerConstrainerEnablerAliases
Description

Tests if this user can manage Id aliases for broker constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if BrokerConstrainerEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasBrokerConstrainerEnabler
Description

Adds an Id to a BrokerConstrainerEnabler for the purpose of creating compatibility. The primary Id of the BrokerConstrainerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another broker constrainer enabler. it is reassigned to the given broker constrainer enabler Id.

Parametersosid.id.IdbrokerConstrainerEnablerIdthe Id of a BrokerConstrainerEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND brokerConstrainerEnablerId not found
NULL_ARGUMENT brokerConstrainerEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.