Interface LogEntryLogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

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

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

getLogEntryIdsByLogs

IdList getLogEntryIdsByLogs(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.

getLogEntriesByLog

LogEntryList getLogEntriesByLog(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.

getLogsByLogEntry

LogList getLogsByLogEntry(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.