org.osid.logging

Interface Log

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Log
extends OsidCatalog

A Log represents a collection of entries. Like all OsidObjects, a Log is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
LogRecord	getLogRecord(Type logRecordType) Gets the record corresponding to the given Log record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getLogRecord

LogRecord getLogRecord(Type logRecordType)
                       throws OperationFailedException

Gets the record corresponding to the given Log record Type. This method is used to retrieve an object implementing the requested record. The logRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(logRecordType) is true .

Parameters:

logRecordType - the type of log record to retrieve

Returns:

the log record

Throws:

NullArgumentException - logRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logRecordType) is false

Compliance:

mandatory - This method must be implemented.