Interface IssueBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, IssueAdminSession, OsidSession, OsidSession
public interface IssueBatchAdminSession extends IssueAdminSession

This session creates, updates, and deletes Issues 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 an Issue , an IssueForm is requested using getIssueFormsForCreate() specifying the desired queues, resources, and record Types or none if no record Types are needed. Each of the returned IssueForms 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 an IssueForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each IssueForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Issues in bulk. To unmap an Issue from the current FrontOffice , the IssueFrontOfficeAssignmentSession should be used. These delete operations attempt to remove the Issue itself thus removing it from all known FrontOffice catalogs. Bulk delete operations return the results in DeleteResponses .