OSID - osid.logging.LogEntryLookupSession Service Interface Definition

Interface	osid.logging.LogEntryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `log entries.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition federated log view: searches include entries in logs of which this log is an ancestor in the log hierarchy isolated log view: searches are restricted to entries in this log only
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	canReadLog
Description	Tests if this user can read the 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 reading operations.
Return	`boolean`		`false` if reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeLogEntryView
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	usePlenaryLogEntryView
Description	A complete view of the `LogEntry` 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	useFederatedLogView
Description	Federates the view for methods in this session. A federated view will include entries in logs which are children of this log in the log hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedLogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this log only.
Compliance	`mandatory`		This method is must be implemented.
Method	getLogEntry
Description	Gets the `LogEntry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `LogEntry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `LogEntry` and retained for compatibility.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of the `LogEntry` to retrieve
Return	`osid.logging.LogEntry`		the returned `LogEntry`
Errors	NOT_FOUND		no `LogEntry` found with the given `Id`
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByIds
Description	Gets a `LogEntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the entries specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible logentries may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`logEntryIds`	the list of `Ids` to retrieve
Return	`osid.logging.LogEntryList`		the returned `LogEntry list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`logEntryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByGenusType
Description	Gets a `LogEntryList` corresponding to the given log entry genus `Type` which doe snot include entries of genus types derived form the specified `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session
Parameters	`osid.type.Type`	`logEntryGenusType`	a log entry genus type
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`logEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByParentGenusType
Description	Gets a `LogEntryList` corresponding to the given log entry genus `Type` and include any additional entries with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`logEntryGenusType`	a log entry genus type
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`logEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByRecordType
Description	Gets a `LogEntryList` containing the given log entry record `Type.` In plenary mode, the returned list contains all known log entries or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
Parameters	`osid.type.Type`	`logEntryGenusType`	a log entry genus type
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`logEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByPriorityType
Description	Gets a `LogEntryList` filtering the list to log entries including and above the given priority `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`priorityType`	a log entry priority type
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByDate
Description	Gets a `LogEntryList` corresponding to the given time interval inclusive. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`start`	a starting time
Parameters	`osid.calendaring.DateTime`	`end`	a starting time
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NULL_ARGUMENT		`start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByPriorityTypeAndDate
Description	Gets a `LogEntryList` corresponding to the given time interval inclusive filtering the list to log entries including and above the given priority `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`priorityType`	a log entry priority type
	`osid.calendaring.DateTime`	`start`	a starting time
	`osid.calendaring.DateTime`	`end`	a starting time
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NULL_ARGUMENT		`priorityType, start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesForResource
Description	Gets a `LogEntryList` for an agent associated with the given resource. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByDateForResource
Description	Gets a `LogEntryList` corresponding to the given time interval inclusive for an agent associated with the given resource. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`start`	a starting time
	`osid.calendaring.DateTime`	`end`	a starting time
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NULL_ARGUMENT		`resourceId, start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByPriorityTypeAndDateForResource
Description	Gets a `LogEntryList` corresponding to the given time interval inclusive for an agent associated with the given resource filtering the list to log entries including and above the given priority `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`priorityType`	a log entry priority type
	`osid.calendaring.DateTime`	`start`	a starting time
	`osid.calendaring.DateTime`	`end`	a starting time
Return	`osid.logging.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NULL_ARGUMENT		`resourceId, priorityType, start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntries
Description	Gets all log entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Return	`osid.logging.LogEntryList`		a list of log entries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.