Interface | osid.learning.batch.ObjectiveBatchAdminSession | ||
---|---|---|---|
Implements | osid.learning.ObjectiveAdminSession | ||
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 | getObjectiveFormsForCreate | ||
Description |
Gets the objective forms for creating a bunch of new objectives. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | objectiveRecordTypes | array of objective record types to be included in each create operation or an empty list if none | |
Return | osid.learning.batch.ObjectiveBatchFormList | the objective forms | |
Errors | NULL_ARGUMENT | objectiveRecordTypes 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 | createAvailabilities | ||
Description |
Creates a new set of | ||
Parameters | osid.learning.batch.ObjectiveBatchFormList | objectiveForms | the objective forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | objectiveForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveFormsForUpdate | ||
Description |
Gets the objective forms for updating an existing set of availabilities. A new objective form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | objectiveIds | the Ids of the Objective |
Return | osid.learning.batch.ObjectiveBatchFormList | the objective form | |
Errors | NOT_FOUND | an objectiveId is not found | |
NULL_ARGUMENT | objectiveIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAvailabilities | ||
Description |
Updates existing availabilities. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.learning.batch.ObjectiveBatchFormList | objectiveForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | objectiveForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAvailabilities | ||
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 | deleteAvailabilities | ||
Description |
Deletes availabilities for the given | ||
Parameters | osid.id.IdList | objectiveIds | the Ids of the availabilities to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | objectiveIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAvailabilities | ||
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. |