Interface | osid.offering.batch.CatalogueBatchAdminSession | ||
---|---|---|---|
Implements | osid.offering.CatalogueAdminSession | ||
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 | getCatalogueFormsForCreate | ||
Description |
Gets the catalogue forms for creating a bunch of new catalogues. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | catalogueRecordTypes | array of catalogue record types to be included in each create operation or an empty list if none | |
Return | osid.offering.batch.CatalogueBatchFormList | the catalogue forms | |
Errors | NULL_ARGUMENT | catalogueRecordTypes 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 | createCatalogues | ||
Description |
Creates a new set of | ||
Parameters | osid.offering.batch.CatalogueBatchFormList | catalogueForms | the catalogue forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | catalogueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueFormsForUpdate | ||
Description |
Gets the catalogue forms for updating an existing set of catalogues. A new catalogue form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | catalogueIds | the Ids of the Catalogue |
Return | osid.offering.batch.CatalogueBatchFormList | the catalogue form | |
Errors | NOT_FOUND | a catalogueId is not found | |
NULL_ARGUMENT | catalogueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCatalogues | ||
Description |
Updates existing catalogues. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.offering.batch.CatalogueBatchFormList | catalogueForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | catalogueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCatalogues | ||
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 | deleteCatalogues | ||
Description |
Deletes catalogues for the given | ||
Parameters | osid.id.IdList | catalogueIds | the Ids of the catalogues to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | catalogueIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCatalogues | ||
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. |