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

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

Modifier and Type	Method	Description
boolean	supportsLogBatchAdmin()	Tests if bulk administration of logs is available.
boolean	supportsLogEntryBatchAdmin()	Tests if bulk administration of log entries is available.
boolean	supportsLogEntryPurgeSession()	Tests if bulk purging of log entries is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

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} .