public interface LoggingSession extends OsidSession
This session is used to log entries to a log.
Modifier and Type | Method and 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(java.lang.Object content,
Type contentType)
Logs an item.
|
void |
logAtPriority(Type priorityType,
java.lang.Object content,
Type contentType)
Logs an item.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getLogId()
Log
Id
associated with this
session. Log Id
associated with this sessionmandatory
- This method must be implemented. Log getLog() throws OperationFailedException, PermissionDeniedException
Log
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLog()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer logging operations. false
if logging methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void log(java.lang.Object content, Type contentType) throws OperationFailedException, PermissionDeniedException
createLogEntry().
content
- the entry to logcontentType
- the type of this entry which must be one of the
types returned by LoggingManager.getContentTypes()
InvalidArgumentException
- content
is
not of contentType
NullArgumentException
- content
or
contentType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
LoggingManager.supportsContentType(contentType)
is
false
mandatory
- This method must be implemented. void logAtPriority(Type priorityType, java.lang.Object content, Type contentType) throws OperationFailedException, PermissionDeniedException
priorityType
- the entry prioritycontent
- the entry to logcontentType
- the type of this entry which must be one of the
types returned by LoggingManager.getContentTypes()
InvalidArgumentException
- content
is
not of contentType
NullArgumentException
- content
,
contentType
or priorityType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
LoggingManager.supportsContentType(contentType)
is
false
or
LoggingManager.supportsPriorityType(priorityType)
is
false
mandatory
- This method must be implemented. LogEntryForm getLogEntryForm()
mandatory
- This method must be implemented. void createLogEntry(LogEntryForm logEntryForm) throws OperationFailedException, PermissionDeniedException
logEntryForm
- the log entry formInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- logEntryForm
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- logEntryForm
is
not of this servicemandatory
- This method must be implemented.