OSID - osid.tracking.LogEntryLookupSession Service Interface Definition

Interface	osid.tracking.LogEntryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving premade `LogEntries.` The `LogEntry` represents a set of efforts `.` 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 isolated front office view: All log entry methods in this session operate, retrieve and pertain to log entries defined explicitly in the current front office. Using an isolated view is useful for managing `LogEntries` with the `LogEntryAdminSession.` federated front office view: All log entry methods in this session operate, retrieve and pertain to all log entries defined in this front office and any other log entries implicitly available in this front office through front office inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedFrontOfficeView()` and `useIsolatedFrontOfficeView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupLogEntries
Description	Tests if this user can perform `LogEntry` lookups. 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup 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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include log entries in front offices which are children of this front office in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this front office 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`	`Id` of the `LogEntry`
Return	`osid.tracking.LogEntry`		the log entry
Errors	NOT_FOUND		`logEntryId` not found
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getLogEntriesByIds
Description	Gets a `LogEntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the log 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.
Parameters	`osid.id.IdList`	`logEntryIds`	the list of `Ids` to retrieve
Return	`osid.tracking.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 does not include log entries of genus types derived from the specified `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.tracking.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 log entries with genus types derived from the specified `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.tracking.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`	`logEntryRecordType`	a log entry record type
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`logEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByDate
Description	Gets a list of log entries logged in the date range. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesForQueue
Description	Gets a `LogEntryList` in the given `Queue.` In plenary mode, the returned list contains all of the log entries, or an error results if a log entry connected to the issue is not found or inaccessible. Otherwise, inaccessible `LogEntries` may be omitted from the list.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByDateForQueue
Description	Gets a list of log entries logged in the date range in the given queue. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`queueId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesForIssue
Description	Gets a `LogEntryList` connected to the given `Issue.` In plenary mode, the returned list contains all of the log entries, or an error results if a log entry connected to the issue is not found or inaccessible. Otherwise, inaccessible `LogEntries` may be omitted from the list.
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByDateForIssue
Description	Gets a list of log entries logged in the date range in the given issue. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.LogEntryList`		the returned `LogEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`issueId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntries
Description	Gets all `LogEntries.` 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.
Return	`osid.tracking.LogEntryList`		a list of `LogEntries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.