OSID - osid.logging.LoggingSession Service Interface Definition

Interface	osid.logging.LoggingSession
Implements	`osid.OsidSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	This session is used to log entries to a log.
Method	getLogId
Description	Gets the `Log` `Id` associated with this session.
Return	`osid.id.Id`		the `Log Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getLog
Description	Gets the `Log` associated with this session.
Return	`osid.logging.Log`		the log
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLog
Description	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.
Return	`boolean`		`false` if logging methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	log
Description	Logs an item. This method is a shortcut to `createLogEntry()`.
Parameters	`object`	`content`	the entry to log
Parameters	`osid.type.Type`	`contentType`	the type of this entry which must be one of the types returned by `LoggingManager.getContentTypes()`
Errors	INVALID_ARGUMENT		`content` is not of `contentType`
	NULL_ARGUMENT		`content` or `contentType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`LoggingManager.supportsContentType(contentType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	logAtPriority
Description	Logs an item.
Parameters	`osid.type.Type`	`priorityType`	the entry priority
	`object`	`content`	the entry to log
	`osid.type.Type`	`contentType`	the type of this entry which must be one of the types returned by `LoggingManager.getContentTypes()`
Errors	INVALID_ARGUMENT		`content` is not of `contentType`
	NULL_ARGUMENT		`content`, `contentType` or `priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`LoggingManager.supportsContentType(contentType)` is `false` or `LoggingManager.supportsPriorityType(priorityType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryForm
Description	Gets a log entry form for creating a log entry.
Return	`osid.logging.LogEntryForm`		the log entry form
Compliance	`mandatory`		This method must be implemented.
Method	createLogEntry
Description	Logs an entry through the log entry form.
Parameters	`osid.logging.LogEntryForm`	`logEntryForm`	the log entry form
Errors	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`logEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`logEntryForm` is not of this service
Compliance	`mandatory`		This method must be implemented.