Interface | osid.provisioning.rules.BrokerConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes broker constrainer
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 | canCreateBrokerConstrainerEnabler | ||
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 | ||
Return | boolean | false if BrokerConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBrokerConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | brokerConstrainerEnablerRecordTypes | array of broker constrainer enabler record types |
Return | boolean | true if BrokerConstrainerEnabler creation
using the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablerFormForCreate | ||
Description |
Gets the broker constrainer enabler form for creating new broker constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | brokerConstrainerEnablerRecordTypes | array of broker constrainer enabler record types |
Return | osid.provisioning.rules.BrokerConstrainerEnablerForm | the broker constrainer enabler form | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerRecordTypes 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 | createBrokerConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.BrokerConstrainerEnablerForm | brokerConstrainerEnablerForm | the form for this BrokerConstrainerEnabler |
Return | osid.provisioning.rules.BrokerConstrainerEnabler | the new BrokerConstrainerEnabler | |
Errors | ILLEGAL_STATE | brokerConstrainerEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | brokerConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerConstrainerEnablerForm did not originate from
getBrokerConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBrokerConstrainerEnablers | ||
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 | ||
Return | boolean | false if BrokerConstrainerEnabler
modification is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablerFormForUpdate | ||
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. | ||
Parameters | osid.id.Id | brokerConstrainerEnablerId | the Id of the BrokerConstrainerEnabler |
Return | osid.provisioning.rules.BrokerConstrainerEnablerForm | the broker constrainer enabler form | |
Errors | NOT_FOUND | brokerConstrainerEnablerId is not found | |
NULL_ARGUMENT | brokerConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBrokerConstrainerEnabler | ||
Description |
Updates an existing broker constrainer enabler. | ||
Parameters | osid.provisioning.rules.BrokerConstrainerEnablerForm | brokerConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | brokerConstrainerEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | brokerConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | brokerConstrainerEnablerForm did not originate from
getBrokerConstrainerEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBrokerConstrainerEnablers | ||
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 | ||
Return | boolean | false if BrokerConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBrokerConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | brokerConstrainerEnablerId | the Id of the BrokerConstrainerEnabler to
remove |
Errors | NOT_FOUND | brokerConstrainerEnablerId not found | |
NULL_ARGUMENT | brokerConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBrokerConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if BrokerConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBrokerConstrainerEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | brokerConstrainerEnablerId | the Id of a BrokerConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | brokerConstrainerEnablerId not found | ||
NULL_ARGUMENT | brokerConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |