OSID Logo
OSID Specifications
logging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.batch.LogEntryBatchAdminSession
Implementsosid.logging.LogEntryAdminSession
Description

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

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

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

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

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

The delete operations delete LogEntries in bulk. To unmap a LogEntry from the current Log, the LogEntryLogAssignmentSession should be used. These delete operations attempt to remove the LogEntry itself thus removing it from all known Log catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetLogEntryFormsForCreate
Description

Gets the log entry forms for creating a bunch of new log entries.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]logEntryRecordTypesarray of log entry record types to be included in each create operation or an empty list if none
Returnosid.logging.batch.LogEntryBatchFormListthe log entry forms
ErrorsNULL_ARGUMENT logEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateLogEntries
Description

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

Parametersosid.logging.batch.LogEntryBatchFormListlogEntryFormsthe log entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT logEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryFormsForUpdate
Description

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

Parametersosid.id.IdListlogEntryIdsthe Ids of the LogEntry
Returnosid.logging.batch.LogEntryBatchFormListthe log entry form
ErrorsNOT_FOUNDa logEntryId is not found
NULL_ARGUMENT logEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateLogEntries
Description

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

Parametersosid.logging.batch.LogEntryBatchFormListlogEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT logEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllLogEntries
Description

Deletes all LogEntries in this Log .

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

Deletes log entries for the given Ids.

Parametersosid.id.IdListlogEntryIdsthe Ids of the log entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT logEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLogEntriesByResource
Description

Deletes log entries for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLogEntriesByDate
Description

Deletes log entries between the given date range inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasLogEntries
Description

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