Interface | osid.installation.batch.DepotBatchAdminSession | ||
---|---|---|---|
Implements | osid.installation.DepotAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getDepotFormsForCreate | ||
Description |
Gets the depot forms for creating a bunch of new depots. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | depotRecordTypes | array of depot record types to be included in each create operation or an empty list if none | |
Return | osid.installation.batch.DepotBatchFormList | the depot forms | |
Errors | NULL_ARGUMENT | depotRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDepots | ||
Description |
Creates a new set of | ||
Parameters | osid.installation.batch.DepotBatchFormList | depotForms | the depot forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | depotForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDepotFormsForUpdate | ||
Description |
Gets the depot forms for updating an existing set of depots. A new depot form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | depotIds | the Ids of the Depot |
Return | osid.installation.batch.DepotBatchFormList | the depot form | |
Errors | NOT_FOUND | an depotId is not found | |
NULL_ARGUMENT | depotIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDepots | ||
Description |
Updates existing depots. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.installation.batch.DepotBatchFormList | depotForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | depotForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllDepots | ||
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 | deleteDepots | ||
Description |
Deletes depots for the given | ||
Parameters | osid.id.IdList | depotIds | the Ids of the depots to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | depotIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasDepots | ||
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. |