OSID - osid.forum.PostLookupSession Service Interface Definition

Interface	osid.forum.PostLookupSession
Implements	`osid.OsidSession`
Used By	`osid.forum.ForumManager`
Used By	`osid.forum.ForumProxyManager`
Description	This session provides methods for retrieving `Posts`. The `Post` represents a collection of replies. 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 forum view: All reply methods in this session operate, retrieve and pertain to posts defined explicitly in the current forum. Using an isolated view is useful for managing posts with the `PostAdminSession`. federated forum view: All post lookup methods in this session operate, retrieve and pertain to all posts defined in this forum and any other forums implicitly available in this forum through forum inheritence. The methods useFederatedForumView() and useIsolatedForumView() behave as a radio group and one should be selected before invoking any lookup methods.
Method	getForumId
Description	Gets the `Forum` `Id` associated with this session.
Return	`osid.id.Id`		the `Forum Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getForum
Description	Gets the `Forum` associated with this session.
Return	`osid.forum.Forum`		the forum
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPosts
Description	Tests if this user can perform `Post` 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 not 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	useComparativePostView
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	usePlenaryPostView
Description	A complete view of the `Post` 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	useFederatedForumView
Description	Federates the view for methods in this session. A federated view will include posts in forums which are children of this forum in the forum hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedForumView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this forum only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPost
Description	Gets the `Post` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Post` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Post` and retained for compatibility.
Parameters	`osid.id.Id`	`postId`	`Id` of the `Post`
Return	`osid.forum.Post`		the post
Errors	NOT_FOUND		`postId` not found
	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPostsByIds
Description	Gets a `PostList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the posts 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 `Posts` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`postIds`	the list of `Ids` to retrieve
Return	`osid.forum.PostList`		the returned `Post` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`postIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostsByGenusType
Description	Gets a `PostList` corresponding to the given post genus `Type` which does not include posts of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Parameters	`osid.type.Type`	`postGenusType`	a post genus type
Return	`osid.forum.PostList`		the returned `Post` list
Errors	NULL_ARGUMENT		`postGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostsByParentGenusType
Description	Gets a `PostList` corresponding to the given post genus `Type` and include any additional posts with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Parameters	`osid.type.Type`	`postGenusType`	a post genus type
Return	`osid.forum.PostList`		the returned `Post` list
Errors	NULL_ARGUMENT		`postGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostsByRecordType
Description	Gets a `PostList` containing the given post record `Type`. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Parameters	`osid.type.Type`	`postRecordType`	a post record type
Return	`osid.forum.PostList`		the returned `Post` list
Errors	NULL_ARGUMENT		`postRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostsByDate
Description	Gets a `PostList` in the given date range inclusive. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts 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.forum.PostList`		the returned `Post` 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	getPostsForPoster
Description	Gets a `PostList` for the given poster. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.forum.PostList`		the returned `Post` 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	getPostsByDateForPoster
Description	Gets a `PostList` by the given poster and in the given date range inclusive. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.forum.PostList`		the returned `Post` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	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	getPosts
Description	Gets all `Posts`. In plenary mode, the returned list contains all known posts or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
Return	`osid.forum.PostList`		a list of `Posts`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.