Interface | osid.financials.posting.batch.PostBatchAdminSession | ||
---|---|---|---|
Implements | osid.financials.posting.PostAdminSession | ||
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 | getPostFormsForCreate | ||
Description |
Gets the post forms for creating a bunch of new posts. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | postRecordTypes | array of post record types to be included in each create operation or an empty list if none | |
Return | osid.financials.posting.batch.PostBatchFormList | the post forms | |
Errors | NULL_ARGUMENT | 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 | createPosts | ||
Description |
Creates a new set of | ||
Parameters | osid.financials.posting.batch.PostBatchFormList | postForms | the post forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | postForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPostFormsForUpdate | ||
Description |
Gets the post forms for updating an existing set of posts. A new post form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | postIds | the Ids of the Post |
Return | osid.financials.posting.batch.PostBatchFormList | the post form | |
Errors | NOT_FOUND | a postId is not found | |
NULL_ARGUMENT | postIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePosts | ||
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.PostBatchFormList | postForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | postForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPosts | ||
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 | deletePosts | ||
Description |
Deletes posts for the given | ||
Parameters | osid.id.IdList | postIds | the Ids of the posts to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | postIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPosts | ||
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. |