Interface LoggingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LoggingSession
extends OsidSession

This session is used to log entries to a log.

Method Summary

Modifier and Type	Method	Description
boolean	canLog()	Tests if this user can log.
void	createLogEntry(LogEntryForm logEntryForm)	Logs an entry through the log entry form.
Log	getLog()	Gets the Log associated with this session.
LogEntryForm	getLogEntryForm()	Gets a log entry form for creating a log entry.
Id	getLogId()	Gets the Log Id associated with this session.
void	log(Object content, Type contentType)	Logs an item.
void	logAtPriority(Type priorityType, Object content, Type contentType)	Logs an item.

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

getLogId

Id getLogId()

Gets the Log Id associated with this session.

Returns:

the Log Id associated with this session

Compliance:

mandatory - This method must be implemented.

getLog

Log getLog()
    throws OperationFailedException,
PermissionDeniedException

Gets the Log associated with this session.

Returns:

the log

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLog

boolean canLog()

Tests if this user can log. 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 logging operations.

Returns:

false if logging methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

log

void log(Object content,
 Type contentType)
  throws OperationFailedException,
PermissionDeniedException

Logs an item. This method is a shortcut to createLogEntry() .

Parameters:

content - the entry to log

contentType - the type of this entry which must be one of the types returned by LoggingManager.getContentTypes()

Throws:

InvalidArgumentException - content is not of contentType

NullArgumentException - content or contentType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - LoggingManager.supportsContentType(contentType) is false

Compliance:

mandatory - This method must be implemented.

logAtPriority

void logAtPriority(Type priorityType,
 Object content,
 Type contentType)
            throws OperationFailedException,
PermissionDeniedException

Logs an item.

Parameters:

priorityType - the entry priority

content - the entry to log

contentType - the type of this entry which must be one of the types returned by LoggingManager.getContentTypes()

Throws:

InvalidArgumentException - content is not of contentType

NullArgumentException - content , contentType or priorityType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - LoggingManager.supportsContentType(contentType) is false or LoggingManager.supportsPriorityType(priorityType) is false

Compliance:

mandatory - This method must be implemented.

getLogEntryForm

LogEntryForm getLogEntryForm()

Gets a log entry form for creating a log entry.

Returns:

the log entry form

Compliance:

mandatory - This method must be implemented.

createLogEntry

void createLogEntry(LogEntryForm logEntryForm)
             throws OperationFailedException,
PermissionDeniedException

Logs an entry through the log entry form.

Parameters:

logEntryForm - the log entry form

Throws:

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - logEntryForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - logEntryForm is not of this service

Compliance:

mandatory - This method must be implemented.