Interface | osid.offering.batch.CanonicalUnitBatchAdminSession | ||
---|---|---|---|
Implements | osid.offering.CanonicalUnitAdminSession | ||
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 | getCanonicalUnitFormsForCreate | ||
Description |
Gets the canonical unit forms for creating a bunch of new canonical units. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | canonicalUnitRecordTypes | array of canonical unit record types to be included in each create operation or an empty list if none | |
Return | osid.offering.batch.CanonicalUnitBatchFormList | the canonical unit forms | |
Errors | NULL_ARGUMENT | canonicalUnitRecordTypes 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 | createCanonicalUnits | ||
Description |
Creates a new set of | ||
Parameters | osid.offering.batch.CanonicalUnitBatchFormList | canonicalUnitForms | the canonical unit forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | canonicalUnitForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitFormsForUpdate | ||
Description |
Gets the canonical unit forms for updating an existing set of canonicalUnits. A new canonical unit form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | canonicalUnitIds | the Ids of the CanonicalUnit |
Return | osid.offering.batch.CanonicalUnitBatchFormList | the canonical unit form | |
Errors | NOT_FOUND | a canonicalUnitId is not found | |
NULL_ARGUMENT | canonicalUnitIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCanonicalUnits | ||
Description |
Updates existing canonical units. 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.CanonicalUnitBatchFormList | canonicalUnitForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | canonicalUnitForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCanonicalUnits | ||
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 | deleteCanonicalUnits | ||
Description |
Deletes canonicalUnits for the given | ||
Parameters | osid.id.IdList | canonicalUnitIds | the Ids of the canonical units to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | canonicalUnitIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCanonicalUnits | ||
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. |