Interface | osid.offering.batch.ResultBatchAdminSession | ||
---|---|---|---|
Implements | osid.offering.ResultAdminSession | ||
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 | getResultFormsForCreate | ||
Description |
Gets the result forms for creating a bunch of new results. A form is returned for each participant. | ||
Parameters | osid.id.IdList | participantIds | a list of participants |
osid.type.Type[] | resultRecordTypes | array of result record types to be included in each create operation or an empty list if none | |
Return | osid.offering.batch.ResultBatchFormList | the result forms | |
Errors | NOT_FOUND | a participantId is not found | |
NULL_ARGUMENT | participantIds or resultRecordTypes 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 | createResults | ||
Description |
Creates a new set of | ||
Parameters | osid.offering.batch.ResultBatchFormList | resultForms | the result forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | resultForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResultFormsForUpdate | ||
Description |
Gets the result forms for updating an existing set of results. A new result form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | resultIds | the Ids of the Result |
Return | osid.offering.batch.ResultBatchFormList | the result form | |
Errors | NOT_FOUND | a resultId is not found | |
NULL_ARGUMENT | resultIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateResults | ||
Description |
Updates existing results. 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.ResultBatchFormList | resultForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | resultForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllResults | ||
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 | deleteResults | ||
Description |
Deletes results for the given | ||
Parameters | osid.id.IdList | resultIds | the Ids of the results to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resultIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteResultsForParticipant | ||
Description |
Deletes results for the given participant. | ||
Parameters | osid.id.Id | participantId | an Id of a participant |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | participantId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasResults | ||
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. |