org.osid.logging.batch

Interface LoggingBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LoggingBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface LoggingBatchProxyManager
extends OsidProxyManager, LoggingBatchProfile

The logging batch proxy manager provides access to logging batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.logging.batch.LoggingBatchProfile

supportsLogBatchAdmin, supportsLogEntryBatchAdmin, supportsLogEntryPurgeSession, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getLogEntryBatchAdminSession

LogEntryBatchAdminSession getLogEntryBatchAdminSession(Proxy proxy)
                                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a LogEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsLogEntryBatchAdmin() is true.

getLogEntryBatchAdminSessionForLog

LogEntryBatchAdminSession getLogEntryBatchAdminSessionForLog(Id logId,
                                                           Proxy proxy)
                                                             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

proxy - a proxy

Returns:

a LogEntryBatchAdminSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryBatchAdmin() and supportsVisibleFederation() are true

getLogEntryPurgeSession

LogEntryPurgeSession getLogEntryPurgeSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the log entry purge service.

Parameters:

proxy - a proxy

Returns:

a LogEntryPurgeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryPurge() is false

Compliance:

optional - This method must be implemented if supportsLogEntryPurge() is true.

getLogEntryPurgeSessionForLog

LogEntryPurgeSession getLogEntryPurgeSessionForLog(Id logId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LogEntryPurgeSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryPurge() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryPurge() and supportsVisibleFederation() are true

getLogBatchAdminSession

LogBatchAdminSession getLogBatchAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk log administration service.

Parameters:

proxy - a proxy

Returns:

a LogBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsLogBatchAdmin() is true.