OSID Logo
OSID Specifications
logging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.batch.LoggingBatchProxyManager
Implementsosid.OsidProxyManager
osid.logging.batch.LoggingBatchProfile
Description

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
MethodgetLogEntryBatchAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.logging.batch.LogEntryBatchAdminSessiona LogEntryBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLogEntryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryBatchAdmin() is true.
MethodgetLogEntryBatchAdminSessionForLog
Description

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

Parametersosid.id.IdlogIdthe Id of the Log
osid.proxy.Proxyproxya proxy
Returnosid.logging.batch.LogEntryBatchAdminSessiona LogEntryBatchAdminSession
ErrorsNOT_FOUNDno Log found by the given Id
NULL_ARGUMENT logId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLogEntryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetLogEntryPurgeSession
Description

Gets the OsidSession associated with the log entry purge service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.logging.batch.LogEntryPurgeSessiona LogEntryPurgeSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLogEntryPurge() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryPurge() is true.
MethodgetLogEntryPurgeSessionForLog
Description

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

Parametersosid.id.IdlogIdthe Id of the Log
osid.proxy.Proxyproxya proxy
Returnosid.logging.batch.LogEntryPurgeSessiona LogEntryPurgeSession
ErrorsNOT_FOUNDno Log found by the given Id
NULL_ARGUMENT logId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLogEntryPurge() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryPurge() and supportsVisibleFederation() are true
MethodgetLogBatchAdminSession
Description

Gets the OsidSession associated with the bulk log administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.logging.batch.LogBatchAdminSessiona LogBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLogBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsLogBatchAdmin() is true.