Interface | osid.provisioning.rules.PoolConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes pool 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 | canCreatePoolConstrainerEnabler | ||
Description |
Tests if this user can create pool constrainer
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 PoolConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePoolConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | poolConstrainerEnablerRecordTypes | array of pool constrainer enabler record types |
Return | boolean | true if PoolConstrainerEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | poolConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolConstrainerEnablerFormForCreate | ||
Description |
Gets the pool constrainer enabler form for creating new pool constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | poolConstrainerEnablerRecordTypes | array of pool constrainer enabler record types |
Return | osid.provisioning.rules.PoolConstrainerEnablerForm | the pool constrainer enabler form | |
Errors | NULL_ARGUMENT | poolConstrainerEnablerRecordTypes 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 | createPoolConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.PoolConstrainerEnablerForm | poolConstrainerEnablerForm | the form for this PoolConstrainerEnabler |
Return | osid.provisioning.rules.PoolConstrainerEnabler | the new PoolConstrainerEnabler | |
Errors | ILLEGAL_STATE | poolConstrainerEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | poolConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | poolConstrainerEnablerForm did not originate from
getPoolconstrainerEnablerForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePoolConstrainerEnablers | ||
Description |
Tests if this user can update pool 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 PoolConstrainerEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolConstrainerEnablerFormForUpdate | ||
Description |
Gets the pool constrainer enabler form for updating a existing pool constrainer enabler. A new pool constrainer enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of the PoolConstrainerEnabler |
Return | osid.provisioning.rules.PoolConstrainerEnablerForm | the pool constrainer enabler form | |
Errors | NOT_FOUND | poolConstrainerEnablerId is not found | |
NULL_ARGUMENT | poolConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePoolConstrainerEnabler | ||
Description |
Updates an existing pool constrainer enabler. | ||
Parameters | osid.provisioning.rules.PoolConstrainerEnablerForm | poolConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | poolConstrainerEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | poolConstrainerEnablerForm did not originate from
getPoolconstrainerEnablerForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePoolConstrainerEnablers | ||
Description |
Tests if this user can delete pool 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 PoolConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePoolConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of the PoolConstrainerEnabler to
remove |
Errors | NOT_FOUND | poolConstrainerEnablerId not found | |
NULL_ARGUMENT | poolConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePoolConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if PoolConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPoolConstrainerEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of a PoolConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | poolConstrainerEnablerId not found | ||
NULL_ARGUMENT | poolConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |