OSID - osid.forum.ReplyLookupSession Service Interface Definition

Interface	osid.forum.ReplyLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving replies. 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 forum view: All reply methods in this session operate, retrieve and pertain to replies defined explicitly in the current forum. Using an isolated view is useful for managing replies with the `ReplyAdminSession.` federated forum view: All reply lookup methods in this session operate, retrieve and pertain to all replies defined in this forum and any other forums implicitly available in this forum through forum inheritence. sequestered reply viiew: All reply methods suppress sequestered replies. unsequestered reply view: All reply methods return all replies. 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	canLookupReplies
Description	Tests if this user can lookup replies. 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 these operations.
Return	`boolean`		`false` if reply lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeReplyView
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	usePlenaryReplyView
Description	A complete view of the `Reply` 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 replies 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	useSequesteredReplyView
Description	The returns from the lookup methods omit sequestered replies.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredReplyView
Description	All replies are returned including sequestered replies.
Compliance	`mandatory`		This method is must be implemented.
Method	getReply
Description	Gets the `Reply` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Reply` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Reply` and retained for compatibility. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`replyId`	the `Id` of the `Reply` to retrieve
Return	`osid.forum.Reply`		the returned `Reply`
Errors	NOT_FOUND		no `Reply` found with the given `Id`
	NULL_ARGUMENT		`replyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByIds
Description	Gets a `ReplyList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the replies 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 replies may be omitted from the list and may present the elements in any order including returning a unique set. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.IdList`	`replyIds`	the list of `Ids` to retrieve
Return	`osid.forum.ReplyList`		the returned `Reply list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`replyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByGenusType
Description	Gets a `ReplyList` corresponding to the given reply genus `Type` which does not include replies of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.type.Type`	`replyGenusType`	a reply genus type
Return	`osid.forum.ReplyList`		the returned `Reply` list
Errors	NULL_ARGUMENT		`replyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByParentGenusType
Description	Gets a `ReplyList` corresponding to the given reply genus `Type` and include any additional replies with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.type.Type`	`replyGenusType`	a reply genus type
Return	`osid.forum.ReplyList`		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	getRepliesByRecordType
Description	Gets a `ReplyList` containing the given reply record `Type.` In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.type.Type`	`replyRecordType`	a reply record type
Return	`osid.forum.ReplyList`		the returned `Post` list
Errors	NULL_ARGUMENT		`replyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByDate
Description	Gets a list of all replies corresponding to the given date range inclusive `.` In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.forum.ReplyList`		the returned `ReplyList`
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	getRepliesForPost
Description	Gets a list of all replies corresponding to a post `Id.` In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByDateForPost
Description	Gets a list of all replies corresponding to post `Id` in the given daterange inclusive. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replis that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`postId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesForPoster
Description	Gets a list of all replies corresponding to a poster. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByDateForPoster
Description	Gets a list of all replies corresponding to a post `Id` for the given poster within the date range inclusive. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.forum.ReplyList`		the returned `ReplyList`
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	getRepliesForPostAndPoster
Description	Gets a list of all replies corresponding to a post `Id` and poster. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	NULL_ARGUMENT		`postId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRepliesByDateForPostAndPoster
Description	Gets a list of all replies corresponding to a post `Id` and poster within the given daterange incluisve. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Parameters	`osid.id.Id`	`postId`	the `Id` of the post
	`osid.id.Id`	`resourceId`	the resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`postId, resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReplies
Description	Gets a list of all replies. In plenary mode, the returned list contains all known replies or an error results. Otherwise, the returned list may contain only those replies that are accessible through this session. In sequestered mode, no sequestered replies are returned. In unsequestered mode, all replies are returned.
Return	`osid.forum.ReplyList`		the returned `ReplyList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.