OSID - osid.logging.LogEntryLogSession Service Interface Definition

Interface	osid.logging.LogEntryLogSession
Implements	`osid.OsidSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	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	useComparativeLogView
Description	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.
Method	usePlenaryLogView
Description	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.
Method	canLookupLogEntryLogMappings
Description	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.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryIdsByLog
Description	Gets the list of `LogEntry` `Ids` associated with a `Log`.
Parameters	`osid.id.Id`	`logId`	`Id` of a `Log`
Return	`osid.id.IdList`		list of related logEntry `Ids`
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByLog
Description	Gets the list of log entries associated with a `Log`.
Parameters	`osid.id.Id`	`logId`	`Id` of a `Log`
Return	`osid.logging.LogEntryList`		list of related logEntry
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryIdsByLogs
Description	Gets the list of `LogEntry Ids` corresponding to a list of `Log` objects.
Parameters	`osid.id.IdList`	`logIds`	list of log `Ids`
Return	`osid.id.IdList`		list of logEntry `Ids`
Errors	NULL_ARGUMENT		`logIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByLog
Description	Gets the list of log entries corresponding to a list of `Log`.
Parameters	`osid.id.IdList`	`logIds`	list of log `Ids`
Return	`osid.logging.LogEntryList`		list of log entries
Errors	NULL_ARGUMENT		`logIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogIdsByLogEntry
Description	Gets the list of `Log` `Ids` mapped to a `LogEntry`.
Parameters	`osid.id.Id`	`logEntryId`	`Id` of a `LogEntry`
Return	`osid.id.IdList`		list of log `Ids`
Errors	NOT_FOUND		`logEntryId` is not found
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogsByLogEntry
Description	Gets the list of `Log` objects mapped to a `LogEntry`.
Parameters	`osid.id.Id`	`logEntryId`	`Id` of a `LogEntry`
Return	`osid.logging.LogList`		list of log
Errors	NOT_FOUND		`logEntryId` is not found
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.