org.osid.logging

Interface LogEntryLogSession

All Superinterfaces:

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

public interface LogEntryLogSession
extends OsidSession

This session provides methods to retrieve LogEntry to Log mappings. An entry may appear in multiple Logs. Each Log may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupLogEntryLogMappings() Tests if this user can perform lookups of logEntry/log mappings.
LogList	getLogByLogEntry(Id logEntryId) Gets the list of Log objects mapped to a LogEntry.
LogEntryList	getLogEntrieByLog(IdList logIds) Gets the list of log entries corresponding to a list of Log.
LogEntryList	getLogEntriesByLog(Id logId) Gets the list of log entries associated with a Log.
IdList	getLogEntryIdsByLog(Id logId) Gets the list of LogEntry Ids associated with a Log.
IdList	getLogEntryIdsByLog(IdList logIds) Gets the list of LogEntry Ids corresponding to a list of Log objects.
IdList	getLogIdsByLogEntry(Id logEntryId) Gets the list of Log Ids mapped to a LogEntry.
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 LogEntry and 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

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 LogEntry and 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.

canLookupLogEntryLogMappings

boolean canLookupLogEntryLogMappings()

Tests if this user can perform lookups of logEntry/log mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getLogEntryIdsByLog

IdList getLogEntryIdsByLog(Id logId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of LogEntry Ids associated with a Log.

Parameters:

logId - Id of a Log

Returns:

list of related logEntry Ids

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogEntriesByLog

LogEntryList getLogEntriesByLog(Id logId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of log entries associated with a Log.

Parameters:

logId - Id of a Log

Returns:

list of related logEntry

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogEntryIdsByLog

IdList getLogEntryIdsByLog(IdList logIds)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the list of LogEntry Ids corresponding to a list of Log objects.

Parameters:

logIds - list of log Ids

Returns:

list of logEntry Ids

Throws:

NullArgumentException - logIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogEntrieByLog

LogEntryList getLogEntrieByLog(IdList logIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the list of log entries corresponding to a list of Log.

Parameters:

logIds - list of log Ids

Returns:

list of log entries

Throws:

NullArgumentException - logIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogIdsByLogEntry

IdList getLogIdsByLogEntry(Id logEntryId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Log Ids mapped to a LogEntry.

Parameters:

logEntryId - Id of a LogEntry

Returns:

list of log Ids

Throws:

NotFoundException - logEntryId is not found

NullArgumentException - logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogByLogEntry

LogList getLogByLogEntry(Id logEntryId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Log objects mapped to a LogEntry.

Parameters:

logEntryId - Id of a LogEntry

Returns:

list of log

Throws:

NotFoundException - logEntryId is not found

NullArgumentException - logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.