Interface | osid.provisioning.batch.ProvisionableBatchAdminSession | ||
---|---|---|---|
Implements | osid.provisioning.ProvisionableAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getProvisionableFormsForCreate | ||
Description |
Gets the provisionable forms for creating a bunch of
new provisionables. A | ||
Parameters | osid.provisioning.batch.ProvisionablePeerList | peers | the relationship peers |
osid.type.Type[] | provisionableRecordTypes | array of provisionable record types to be included in each create operation or an empty list if none | |
Return | osid.provisioning.batch.ProvisionableBatchFormList | the provisionable forms | |
Errors | NOT_FOUND | a resourceId or poolId is not found | |
NULL_ARGUMENT | peers or provisionableRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request transaction forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createProvisionables | ||
Description |
Creates a new set of | ||
Parameters | osid.provisioning.batch.ProvisionableBatchFormList | provisionableForms | the provisionable forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | provisionableForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableFormsForUpdate | ||
Description |
Gets the provisionable forms for updating an existing set of provisionables. A new provisionable form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | provisionableIds | the Ids of the Provisionable |
Return | osid.provisioning.batch.ProvisionableBatchFormList | the provisionable form | |
Errors | NOT_FOUND | a provisionableId is not found | |
NULL_ARGUMENT | provisionableIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProvisionables | ||
Description |
Updates existing provisionables. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.provisioning.batch.ProvisionableBatchFormList | provisionableForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | provisionableForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProvisionables | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProvisionables | ||
Description |
Deletes provisionables for the given | ||
Parameters | osid.id.IdList | provisionableIds | the Ids of the provisionables to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | provisionableIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProvisionablesForResource | ||
Description |
Deletes all provisionables for the given resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProvisionablesForPool | ||
Description |
Deletes all provisionables for the given pool. | ||
Parameters | osid.id.Id | poolId | an Id of a pool |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | poolId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveProvisionablesByDate | ||
Description |
Deletes provisionables expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProvisionables | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |