Interface | osid.calendaring.batch.CommitmentBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.CommitmentAdminSession | ||
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 | getCommitmentFormsForCreate | ||
Description |
Gets the commitmentforms for creating a bunch of new commitments. A form is returned for each supplied event and resource pair. | ||
Parameters | osid.calendaring.batch.CommitmentPeerList | peers | a list of commitment peers |
osid.type.Type[] | commitmentRecordTypes | array of commitment record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.batch.CommitmentBatchFormList | the commitment forms | |
Errors | NOT_FOUND | an eventId or resourceId is not found | |
NULL_ARGUMENT | peers or commitmentRecordTypes 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 | createCommitments | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.batch.CommitmentBatchFormList | commitmentForms | the commitment forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | commitmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentFormsForUpdate | ||
Description |
Gets the commitment forms for updating an existing set of commitments. A new commitmentform should be requested for each update transaction. | ||
Parameters | osid.id.IdList | commitmentIds | the Ids of the Commitment |
Return | osid.calendaring.batch.CommitmentBatchFormList | the commitment form | |
Errors | NOT_FOUND | a commitmentId is not found | |
NULL_ARGUMENT | commitmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCommitments | ||
Description |
Updates existing commitments. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.calendaring.batch.CommitmentBatchFormList | commitmentForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | commitmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCommitments | ||
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 | deleteCommitments | ||
Description |
Deletes commitments for the given | ||
Parameters | osid.id.IdList | commitmentIds | the Ids of the commitments to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | commitmentIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCommitmentsForEvent | ||
Description |
Deletes all commitments related to the given event. | ||
Parameters | osid.id.Id | eventId | an Id of an event |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | eventId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCommitmentsForResource | ||
Description |
Deletes all commitments related to the given resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveCommitmentsByDate | ||
Description |
Deletes all commitments expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCommitments | ||
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. |