org.osid.logging

Interface LogLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface LogLookupSession
extends OsidSession

This session provides methods for retrieving Log objects. The Log represents a collection of log entries.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Logs it can access, without breaking execution. However, an assessment may only be useful if all Logs referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupLogs() Tests if this user can perform Log lookups.
Log	getLog(Id logId) Gets the Log specified by its Id.
LogList	getLogs() Gets all Logs.
LogList	getLogsByGenusType(Type logGenusType) Gets a LogList corresponding to the given log genus Type which does not include logs of genus types derived from the specified Type.
LogList	getLogsByIds(IdList logIds) Gets a LogList corresponding to the given IdList.
LogList	getLogsByParentGenusType(Type logGenusType) Gets a LogList corresponding to the given log genus Type and include any additional logs with genus types derived from the specified Type.
LogList	getLogsByProvider(Id resourceId) Gets a LogList for a given provider.
LogList	getLogsByRecordType(Type logRecordType) Gets a LogList containing the given log record Type.
void	useComparativeLogView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryLogView() A complete view of the Log returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupLogs

boolean canLookupLogs()

Tests if this user can perform Log lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeLogView

void useComparativeLogView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryLogView

void usePlenaryLogView()

A complete view of the Log returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getLog

Log getLog(Id logId)
           throws NotFoundException,
                  OperationFailedException,
                  PermissionDeniedException

Gets the Log specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Log may have a different Id than requested, such as the case where a duplicate Id was assigned to a Log and retained for compatibility.

Parameters:

logId - Id of the Log

Returns:

the log

Throws:

NotFoundException - logId not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getLogsByIds

LogList getLogsByIds(IdList logIds)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets a LogList corresponding to the given IdList. In plenary mode, the returned list contains all of the logs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Logs may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

logIds - the list of Ids to retrieve

Returns:

the returned Log list

Throws:

NotFoundException - an Id was not found

NullArgumentException - logIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogsByGenusType

LogList getLogsByGenusType(Type logGenusType)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a LogList corresponding to the given log genus Type which does not include logs of genus types derived from the specified Type. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parameters:

logGenusType - a log genus type

Returns:

the returned Log list

Throws:

NullArgumentException - logGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogsByParentGenusType

LogList getLogsByParentGenusType(Type logGenusType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a LogList corresponding to the given log genus Type and include any additional logs with genus types derived from the specified Type. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parameters:

logGenusType - a log genus type

Returns:

the returned Log list

Throws:

NullArgumentException - logGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogsByRecordType

LogList getLogsByRecordType(Type logRecordType)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets a LogList containing the given log record Type. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parameters:

logRecordType - a log record type

Returns:

the returned Log list

Throws:

NullArgumentException - logRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogsByProvider

LogList getLogsByProvider(Id resourceId)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets a LogList for a given provider. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Log list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogs

LogList getLogs()
                throws OperationFailedException,
                       PermissionDeniedException

Gets all Logs. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Returns:

a list of Logs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.