org.osid.inquiry.batch

Interface AuditBatchAdminSession

All Superinterfaces:

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

public interface AuditBatchAdminSession
extends AuditAdminSession

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

To create an Audit, an AuditForm is requested using getAuditFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned AuditForms 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 AuditForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AuditForms corresponds to an attempted transaction.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAudits(AliasRequestList aliasRequests) Adds an Id to an Audit for the purpose of creating compatibility.
CreateResponseList	createAudits(AuditBatchFormList auditForms) Creates a new set of Audits.
DeleteResponseList	deleteAllAudits() Deletes all Audits in this Inquest.
AuditBatchFormList	getAuditFormsForCreate(long n, Type[] auditRecordTypes) Gets the audit forms for creating a bunch of new audtits.
AuditBatchFormList	getAuditFormsForUpdate(IdList auditIds) Gets the audit forms for updating an existing set of audits.
UpdateResponseList	updateAudits(AuditBatchFormList auditForms) Updates existing auditis.

Methods inherited from interface org.osid.inquiry.AuditAdminSession

aliasAudit, canCreateAudit, canCreateAuditWithRecordTypes, canDeleteAudits, canManageAuditAliases, canUpdateAudits, createAudit, deleteAudit, getAuditFormForCreate, getAuditFormForUpdate, getInquest, getInquestId, updateAudit

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

getAuditFormsForCreate

AuditBatchFormList getAuditFormsForCreate(long n,
                                        Type[] auditRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the audit forms for creating a bunch of new audtits.

Parameters:

n - number of forms to retrieve

auditRecordTypes - array of audtit record types to be included in each create operation or an empty list if none

Returns:

the audit forms

Throws:

NullArgumentException - auditRecordTypes 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.

createAudits

CreateResponseList createAudits(AuditBatchFormList auditForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

auditForms - the audit forms

Returns:

the create responses

Throws:

NullArgumentException - auditForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditFormsForUpdate

AuditBatchFormList getAuditFormsForUpdate(IdList auditIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the audit forms for updating an existing set of audits. A new audit form should be requested for each update transaction.

Parameters:

auditIds - the Ids of the Audits

Returns:

the audit forms

Throws:

NotFoundException - an auditId is not found

NullArgumentException - auditIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAudits

UpdateResponseList updateAudits(AuditBatchFormList auditForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing auditis. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

auditForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - auditForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAudits

DeleteResponseList deleteAllAudits()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Audits in this Inquest.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAudits

AliasResponseList aliasAudits(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an Id to an Audit for the purpose of creating compatibility. The primary Id of the Audit is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another audit, it is reassigned to the given audit 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.