Interface | osid.provisioning.rules.BrokerProcessorEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes broker processor enablers.
The data for create and update is provided via the | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBrokerProcessorEnabler | ||
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 | ||
Return | boolean | false if BrokerProcessorEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBrokerProcessorEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | brokerProcessorEnablerRecordTypes | array of broker processor enabler record types |
Return | boolean | true if BrokerProcessorEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | brokerProcessorEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerProcessorEnablerFormForCreate | ||
Description |
Gets the broker processor enabler form for creating new broker processor enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | brokerProcessorEnablerRecordTypes | array of broker processor enabler record types |
Return | osid.provisioning.rules.BrokerProcessorEnablerForm | the broker processor enabler form | |
Errors | NULL_ARGUMENT | brokerProcessorEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBrokerProcessorEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.BrokerProcessorEnablerForm | brokerProcessorEnablerForm | the form for this BrokerProcessorEnabler |
Return | osid.provisioning.rules.BrokerProcessorEnabler | the new BrokerProcessorEnabler | |
Errors | ILLEGAL_STATE | brokerProcessorEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | brokerProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerProcessorEnablerForm did not originate from
getBrokerProcessorEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBrokerProcessorEnablers | ||
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 | ||
Return | boolean | false if BrokerProcessorEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerProcessorEnablerFormForUpdate | ||
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. | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler |
Return | osid.provisioning.rules.BrokerProcessorEnablerForm | the broker processor enabler form | |
Errors | NOT_FOUND | brokerProcessorEnablerId is not found | |
NULL_ARGUMENT | brokerProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBrokerProcessorEnabler | ||
Description |
Updates an existing broker processor enabler. | ||
Parameters | osid.provisioning.rules.BrokerProcessorEnablerForm | brokerProcessorEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | brokerProcessorEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | brokerProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerProcessorEnablerForm did not originate from
getBrokerProcessorEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBrokerProcessorEnablers | ||
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 | ||
Return | boolean | false if BrokerProcessorEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBrokerProcessorEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler to
remove |
Errors | NOT_FOUND | brokerProcessorEnablerId not found | |
NULL_ARGUMENT | brokerProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBrokerProcessorEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if BrokerProcessorEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBrokerProcessorEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of a BrokerProcessorEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | brokerProcessorEnablerId not found | ||
NULL_ARGUMENT | brokerProcessorEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |