Interface | osid.journaling.batch.JournalEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.journaling.JournalEntryAdminSession | ||
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 | getJournalEntryFormsForCreate | ||
Description |
Gets the journal entry forms for creating a bunch of
new journal entries. A | ||
Parameters | osid.journaling.batch.JournalEntryPeerList | peers | a list of journal entry peers |
osid.type.Type[] | journalEntryRecordTypes | array of journal entry record types to be included in each create operation or an empty list if none | |
Return | osid.journaling.batch.JournalEntryBatchFormList | the journal entry forms | |
Errors | NOT_FOUND | a branchId or sourceId is not found | |
NULL_ARGUMENT | peers or journalEntryRecordTypes 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 | createJournalEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.journaling.batch.JournalEntryBatchFormList | journalEntryForms | the journal entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | journalEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntryFormsForUpdate | ||
Description |
Gets the journal entry forms for updating an existing set of journal entries. A new journal entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | journalEntryIds | the Ids of the JournalEntry |
Return | osid.journaling.batch.JournalEntryBatchFormList | the journal entry form | |
Errors | NOT_FOUND | a journalEntryId is not found | |
NULL_ARGUMENT | journalEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateJournalEntries | ||
Description |
Updates existing journal entries. This method returns
an error if the entire operation fails. Otherwise, the
status of an individual update operation is indicated in
the | ||
Parameters | osid.journaling.batch.JournalEntryBatchFormList | journalEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | journalEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllJournalEntries | ||
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 | deleteJournalEntries | ||
Description |
Deletes journal entries for the given | ||
Parameters | osid.id.IdList | journalEntryIds | the Ids of the journal entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | journalEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteJournalEntriesForBranch | ||
Description |
Deletes journal entries for the given branch. | ||
Parameters | osid.id.Id | branchId | the Id of a branch |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | branchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteJournalEntriesForSource | ||
Description |
Deletes journal entries for the given source. | ||
Parameters | osid.id.Id | sourceId | the Id of a source |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteJournalEntriesByDate | ||
Description |
Deletes journal entries between the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasJournalEntries | ||
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. |