Interface LoggingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, LoggingBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface LoggingBatchManager
extends OsidManager, LoggingBatchProfile

The logging batch manager provides access to logging batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• LogEntryBatchAdminSession: a session to create, modify and delete log entries in bulk
• LogEntryPurgeSession: a session to purge logs
• LogBatchAdminSession: a session to create, modify and delete logs in bulk

LoggingBatchManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
LogBatchAdminSession	getLogBatchAdminSession()	Gets the OsidSession associated with the bulk log administration service.
LogEntryBatchAdminSession	getLogEntryBatchAdminSession()	Gets the OsidSession associated with the bulk log entry administration service.
LogEntryBatchAdminSession	getLogEntryBatchAdminSessionForLog(Id logId)	Gets the OsidSession associated with the bulk log entry administration service for the given log.
LogEntryPurgeSession	getLogEntryPurgeSession()	Gets the OsidSession associated with the log entry purge service.
LogEntryPurgeSession	getLogEntryPurgeSessionForLog(Id logId)	Gets the OsidSession associated with the log entry purge service for the given log.

Methods inherited from interface Closeable

close

Methods inherited from interface LoggingBatchProfile

supportsLogBatchAdmin, supportsLogEntryBatchAdmin, supportsLogEntryPurgeSession, supportsVisibleFederation

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getLogEntryBatchAdminSession

LogEntryBatchAdminSession getLogEntryBatchAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk log entry administration service.

Returns:

a LogEntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryBatchAdmin()} is {@code true}.

getLogEntryBatchAdminSessionForLog

LogEntryBatchAdminSession getLogEntryBatchAdminSessionForLog(Id logId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk log entry administration service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntryBatchAdminSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryPurgeSession

LogEntryPurgeSession getLogEntryPurgeSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the log entry purge service.

Returns:

a LogEntryPurgeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryPurge() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryPurge()} is {@code true}.

getLogEntryPurgeSessionForLog

LogEntryPurgeSession getLogEntryPurgeSessionForLog(Id logId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the log entry purge service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntryPurgeSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryPurge() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryPurge()} and {@code supportsVisibleFederation()} are {@code true}

getLogBatchAdminSession

LogBatchAdminSession getLogBatchAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the bulk log administration service.

Returns:

a LogBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLogBatchAdmin()} is {@code true}.