org.osid.financials.posting.batch

Interface PostEntryBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PostEntryAdminSession

public interface PostEntryBatchAdminSession
extends PostEntryAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPostEntries(AliasRequestList aliasRequests) Adds an Id to a PostEntry for the purpose of creating compatibility.
CreateResponseList	createPostEntries(PostEntryBatchFormList postEntryForms) Creates a new set of PostEntries.
DeleteResponseList	deleteAllPostEntries() Deletes all PostEntries in this Business .
DeleteResponseList	deletePostEntries(IdList postEntryIds) Deletes post entries for the given Ids.
DeleteResponseList	deletePostEntriesForPost(Id postId) Deletes post entries for the given post.
PostEntryBatchFormList	getPostEntryFormsForCreate(IdList postIds, Type[] postRecordTypes) Gets the post entry forms for creating a bunch of new posts.
PostEntryBatchFormList	getPostEntryFormsForUpdate(IdList postEntryIds) Gets the post entry forms for updating an existing set of posts.
UpdateResponseList	updatePostEntries(PostEntryBatchFormList postEntryForms) Updates existing posts.

Methods inherited from interface org.osid.financials.posting.PostEntryAdminSession

aliasPostEntry, canCreatePostEntries, canCreatePostEntryWithRecordTypes, canDeletePostEntries, canManagePostEntryAliases, canUpdatePostEntries, createPostEntry, deletePostEntry, getBusiness, getBusinessId, getPostEntryFormForCreate, getPostEntryFormForUpdate, updatePostEntry

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPostEntryFormsForCreate

PostEntryBatchFormList getPostEntryFormsForCreate(IdList postIds,
                                                Type[] postRecordTypes)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

postIds - a list of post Ids

postRecordTypes - array of post entry record types to be included in each create operation or an empty list if none

Returns:

the post entry forms

Throws:

NotFoundException - a postId is not found

NullArgumentException - peers or postRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPostEntries

CreateResponseList createPostEntries(PostEntryBatchFormList postEntryForms)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

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 .

Parameters:

postEntryForms - the post entry forms

Returns:

the create responses

Throws:

NotFoundException - postEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntryFormsForUpdate

PostEntryBatchFormList getPostEntryFormsForUpdate(IdList postEntryIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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:

postEntryIds - the Ids of the PostEntry

Returns:

the post entry form

Throws:

NotFoundException - a postEntryId is not found

NullArgumentException - postEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePostEntries

UpdateResponseList updatePostEntries(PostEntryBatchFormList postEntryForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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 .

Parameters:

postEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - postEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPostEntries

DeleteResponseList deleteAllPostEntries()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all PostEntries in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePostEntries

DeleteResponseList deletePostEntries(IdList postEntryIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes post entries for the given Ids.

Parameters:

postEntryIds - the Ids of the post entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - postEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePostEntriesForPost

DeleteResponseList deletePostEntriesForPost(Id postId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes post entries for the given post.

Parameters:

postId - the Id of a post

Returns:

the delete responses

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPostEntries

AliasResponseList aliasPostEntries(AliasRequestList aliasRequests)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.