OSID Logo
OSID Specifications
financials posting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.batch.PostEntryBatchAdminSession
Implementsosid.financials.posting.PostEntryAdminSession
Description

This session creates, updates, and deletes PostEntries in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a PostEntry, a PostEntryForm is requested using getPostEntryFormsForCreate() specifying the desired post entry peers and record Types or none if no record Types are needed. Each of the returned PostEntryForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a PostEntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PostEntryForm corresponds to an attempted transaction.

The PostEntryForms returned from getPostEntryFormsForCreate() may be linked to the originating request through the peer Ids of the PostEntryForm. In the case where there may be duplicates, any PostEntryForm of the same peer Ids may be used for a create operation.

Once a batch of PostEntryForms are submitted for create, a CreateResponse is returned for each PostEntryForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createPostEntries(), errors specific to an individual PostEntryForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating PostEntryForm through the PostEntryForm Id .

For updates, PostEntryForms are requested to the PostEntry Id that is to be updated using getPostEntryFormsForUpdate() where the reference Id in the PostEntryForm may be used to link the request. Similarly, the PostEntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The PostEntryForm can only be used once for a successful update and cannot be reused.

Once a batch of PostEntryForms are submitted for update, an UpdateResponse is returned for each PostEntryForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updatePostEntries(), errors specific to an individual PostEntryForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating PostEntryForm through the PostEntryForm Id.

The delete operations delete PostEntries in bulk. To unmap a PostEntry from the current Business, the PostEntryBusinessAssignmentSession should be used. These delete operations attempt to remove the PostEntry itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetPostEntryFormsForCreate
Description

Gets the post entry forms for creating a bunch of new posts. A form is returned for each supplied post.

Parametersosid.id.IdListpostIdsa list of post Ids
osid.type.Type[]postRecordTypesarray of post entry record types to be included in each create operation or an empty list if none
Returnosid.financials.posting.batch.PostEntryBatchFormListthe post entry forms
ErrorsNOT_FOUNDa postId is not found
NULL_ARGUMENT peers or postRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreatePostEntries
Description

Creates a new set of PostEntries. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.financials.posting.batch.PostEntryBatchFormListpostEntryFormsthe post entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNOT_FOUND postEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPostEntryFormsForUpdate
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.

Parametersosid.id.IdListpostEntryIdsthe Ids of the PostEntry
Returnosid.financials.posting.batch.PostEntryBatchFormListthe post entry form
ErrorsNOT_FOUNDa postEntryId is not found
NULL_ARGUMENT postEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePostEntries
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 BatchCreateResponse .

Parametersosid.financials.posting.batch.PostEntryBatchFormListpostEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT postEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPostEntries
Description

Deletes all PostEntries in this Business .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePostEntries
Description

Deletes post entries for the given Ids.

Parametersosid.id.IdListpostEntryIdsthe Ids of the post entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT postEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePostEntriesForPost
Description

Deletes post entries for the given post.

Parametersosid.id.IdpostIdthe Id of a post
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPostEntries
Description

Adds an Id to a PostEntry for the purpose of creating compatibility. The primary Id of the PostEntry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another post entry, it is reassigned to the given post entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.