Interface | osid.financials.posting.batch.PostEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.financials.posting.PostEntryAdminSession | ||
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 | getPostEntryFormsForCreate | ||
Description |
Gets the post entry forms for creating a bunch of new posts. A form is returned for each supplied post. | ||
Parameters | osid.id.IdList | postIds | a list of post Ids |
osid.type.Type[] | postRecordTypes | array of post entry record types to be included in each create operation or an empty list if none | |
Return | osid.financials.posting.batch.PostEntryBatchFormList | the post entry forms | |
Errors | NOT_FOUND | a postId is not found | |
NULL_ARGUMENT | peers or postRecordTypes 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 | createPostEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.financials.posting.batch.PostEntryBatchFormList | postEntryForms | the post entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NOT_FOUND | postEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPostEntryFormsForUpdate | ||
Description |
Gets the post entry forms for updating an existing set of posts. A new post entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | postEntryIds | the Ids of the PostEntry |
Return | osid.financials.posting.batch.PostEntryBatchFormList | the post entry form | |
Errors | NOT_FOUND | a postEntryId is not found | |
NULL_ARGUMENT | postEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePostEntries | ||
Description |
Updates existing posts. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.financials.posting.batch.PostEntryBatchFormList | postEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | postEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPostEntries | ||
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 | deletePostEntries | ||
Description |
Deletes post entries for the given | ||
Parameters | osid.id.IdList | postEntryIds | the Ids of the post entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | postEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deletePostEntriesForPost | ||
Description |
Deletes post entries for the given post. | ||
Parameters | osid.id.Id | postId | the Id of a post |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | postId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPostEntries | ||
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. |