OSID - osid.blogging.EntryLookupSession Service Interface Definition

Interface	osid.blogging.EntryLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving entries. 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 isolated blog view: All entry methods in this session operate, retrieve and pertain to entries defined explicitly in the current blog. Using an isolated view is useful for managing `Entries` with the `EntryAdminSession.` federated blog view: All entry methods in this session operate, retrieve and pertain to all entries defined in this blog and any other entries implicitly available in this blog through blog inheritence. The methods `useFederatedBlogView()` and `useIsolatedBlogView()` behave as a radio group and one should be selected before invoking any lookup methods. Entries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Entry.`
Method	getBlogId
Description	Gets the `Blog` `Id` associated with this session.
Return	`osid.id.Id`		the `Blog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBlog
Description	Gets the `Blog` associated with this session.
Return	`osid.blogging.Blog`		the `Blog` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupEntries
Description	Tests if this user can perform `Entry` 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeEntryView
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	usePlenaryEntryView
Description	A complete view of the `Entry` 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	useFederatedBlogView
Description	Federates the view for methods in this session. A federated view will include entries in blogs which are children of this blog in the blog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBlogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this blog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getEntry
Description	Gets the `Entry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Entry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Entry` and retained for compatibility.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry` to retrieve
Return	`osid.blogging.Entry`		the returned `Entry`
Errors	NOT_FOUND		no `Entry` found with the given `Id`
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByIds
Description	Gets an `EntryList` 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 `Entries` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`entryIds`	the list of `Ids` to retrieve
Return	`osid.blogging.EntryList`		the returned `Entry list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`entryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByGenusType
Description	Gets an `EntryList` corresponding to the given entry genus `Type` which does not include entries of 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`	`entryGenusType`	an entry genus type
Return	`osid.blogging.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByParentGenusType
Description	Gets an `EntryList` corresponding to the given 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`	`entryGenusType`	an entry genus type
Return	`osid.blogging.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByRecordType
Description	Gets an `EntryList` containing the given entry record `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`	`entryRecordType`	an entry record type
Return	`osid.blogging.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByDate
Description	Gets an `EntryList` posted within the specified range 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`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.blogging.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	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	getEntriesForPoster
Description	Gets an `EntryList` for the given poster resource `Id.` 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 poster `Id`
Return	`osid.blogging.EntryList`		the returned `Entry` 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	getEntriesByDateForPoster
Description	Gets an `EntryList` for a poster resource `Id` posted within the specified range 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.id.Id`	`resourceId`	a poster `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.blogging.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByProvider
Description	Gets an `EntryList` for the given provider. 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.blogging.EntryList`		the returned `Entry` 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	getEntries
Description	Gets all `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.blogging.EntryList`		a list of `Entries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.