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

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

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

Tests if this user can create broker processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a BrokerProcessorEnabler 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 BrokerProcessorEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateBrokerProcessorEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]brokerProcessorEnablerRecordTypesarray of broker processor enabler record types
Returnboolean true if BrokerProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT brokerProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerFormForCreate
Description

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

Parametersosid.type.Type[]brokerProcessorEnablerRecordTypesarray of broker processor enabler record types
Returnosid.provisioning.rules.BrokerProcessorEnablerFormthe broker processor enabler form
ErrorsNULL_ARGUMENT brokerProcessorEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateBrokerProcessorEnabler
Description

Creates a new BrokerProcessorEnabler.

Parametersosid.provisioning.rules.BrokerProcessorEnablerFormbrokerProcessorEnablerFormthe form for this BrokerProcessorEnabler
Returnosid.provisioning.rules.BrokerProcessorEnablerthe new BrokerProcessorEnabler
ErrorsILLEGAL_STATE brokerProcessorEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT brokerProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerProcessorEnablerForm did not originate from getBrokerProcessorEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateBrokerProcessorEnablers
Description

Tests if this user can update broker processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a BrokerProcessorEnabler 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 BrokerProcessorEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerFormForUpdate
Description

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

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler
Returnosid.provisioning.rules.BrokerProcessorEnablerFormthe broker processor enabler form
ErrorsNOT_FOUND brokerProcessorEnablerId is not found
NULL_ARGUMENT brokerProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBrokerProcessorEnabler
Description

Updates an existing broker processor enabler.

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

Tests if this user can delete broker processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a BrokerProcessorEnabler 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 BrokerProcessorEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteBrokerProcessorEnabler
Description

Deletes a BrokerProcessorEnabler.

Parametersosid.id.IdbrokerProcessorEnablerIdthe Id of the BrokerProcessorEnabler to remove
ErrorsNOT_FOUND brokerProcessorEnablerId not found
NULL_ARGUMENT brokerProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageBrokerProcessorEnablerAliases
Description

Tests if this user can manage Id aliases for broker processor 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 BrokerProcessorEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasBrokerProcessorEnabler
Description

Adds an Id to a BrokerProcessorEnabler for the purpose of creating compatibility. The primary Id of the BrokerProcessorEnabler 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 processor enabler. it is reassigned to the given broker processor enabler Id.

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