Interface | osid.provisioning.ProvisionableAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateProvisionables | ||
Description |
Tests if this user can create provisionables. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if Provisionable creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProvisionableWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | provisionableRecordTypes | array of provisionable record types |
Return | boolean | true if Provisionable creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | provisionableRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableFormForCreate | ||
Description |
Gets the provisionable form for creating new provisionables. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | resourceId | the Id for the resource |
osid.id.Id | poolId | the Id for the pool | |
osid.type.Type[] | provisionableRecordTypes | array of provisionable record types | |
Return | osid.provisioning.ProvisionableForm | the provisionable form | |
Errors | NOT_FOUND | resourceId or poolId is not found | |
NULL_ARGUMENT | resourceId, or poolId, or provisionableRecordTypes
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 | createProvisionable | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.ProvisionableForm | provisionableForm | the form for this Provisionable |
Return | osid.provisioning.Provisionable | the new Provisionable | |
Errors | ILLEGAL_STATE | provisionableForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | provisionableForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | provisionableForm did not originate from
getProvisionableFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProvisionables | ||
Description |
Tests if this user can update provisionables. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if Provisionable modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableFormForUpdate | ||
Description |
Gets the provisionable form for updating an existing provisionable. A new provisionable form should be requested for each update transaction. | ||
Parameters | osid.id.Id | provisionableId | the Id of the Provisionable |
Return | osid.provisioning.ProvisionableForm | the provisionable form | |
Errors | NOT_FOUND | provisionableId is not found | |
NULL_ARGUMENT | provisionableId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProvisionable | ||
Description |
Updates an existing provisionable. | ||
Parameters | osid.provisioning.ProvisionableForm | provisionableForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | provisionableForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | provisionableForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | provisionableForm did not originate from
getProvisionableFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProvisionables | ||
Description |
Tests if this user can delete provisionables. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if Provisionable deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProvisionable | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | provisionableId | the Id of the Provisionable to remove |
Errors | NOT_FOUND | provisionableId not found | |
NULL_ARGUMENT | provisionableId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProvisionableAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Provisionable aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProvisionable | ||
Description |
Adds an | ||
Parameters | osid.id.Id | provisionableId | the Id of a Provisionable |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | provisionableId not found | ||
NULL_ARGUMENT | provisionableId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |