org.osid.logging.batch

Interface LogBatchAdminSession

All Superinterfaces:

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

public interface LogBatchAdminSession
extends LogAdminSession

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

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

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

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

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

The delete operations delete Logs in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasLogs(AliasRequestList aliasRequests) Adds an Id to a Log for the purpose of creating compatibility.
CreateResponseList	createLogs(LogBatchFormList logForms) Creates a new set of Logs.
DeleteResponseList	deleteAllLogs() Deletes all Logs.
DeleteResponseList	deleteLogs(IdList logIds) Deletes logs for the given Ids.
LogBatchFormList	getLogFormsForCreate(long number, Type[] logRecordTypes) Gets the log forms for creating a bunch of new logs.
LogBatchFormList	getLogFormsForUpdate(IdList logIds) Gets the log forms for updating an existing set of logs.
UpdateResponseList	updateLogs(LogBatchFormList logForms) Updates existing logs.

Methods inherited from interface org.osid.logging.LogAdminSession

aliasLog, canCreateLogs, canCreateLogWithRecordTypes, canDeleteLogs, canManageLogAliases, canUpdateLogs, createLog, deleteLog, getLogFormForCreate, getLogFormForUpdate, updateLog

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

getLogFormsForCreate

LogBatchFormList getLogFormsForCreate(long number,
                                    Type[] logRecordTypes)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets the log forms for creating a bunch of new logs.

Parameters:

number - the number of forms to retrieve

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

Returns:

the log forms

Throws:

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

createLogs

CreateResponseList createLogs(LogBatchFormList logForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

logForms - the log forms

Returns:

the create responses

Throws:

NullArgumentException - logForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogFormsForUpdate

LogBatchFormList getLogFormsForUpdate(IdList logIds)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

logIds - the Ids of the Log

Returns:

the log form

Throws:

NotFoundException - a logId is not found

NullArgumentException - logIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateLogs

UpdateResponseList updateLogs(LogBatchFormList logForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

logForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - logForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllLogs

DeleteResponseList deleteAllLogs()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes all Logs.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteLogs

DeleteResponseList deleteLogs(IdList logIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

Deletes logs for the given Ids.

Parameters:

logIds - the Ids of the logs to delete

Returns:

the delete responses

Throws:

NullArgumentException - logIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasLogs

AliasResponseList aliasLogs(AliasRequestList aliasRequests)
                            throws OperationFailedException,
                                   PermissionDeniedException

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