OSID - osid.inquiry.ResponseLookupSession Service Interface Definition

Interface	osid.inquiry.ResponseLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving responses. 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 inquest view: All response methods in this session operate, retrieve and pertain to responses defined explicitly in the current inquest. Using an isolated view is useful for managing `Responses` with the `ResponseAdminSession.` federated inquest view: All response lookup methods in this session operate, retrieve and pertain to all responses defined in this inquest and any other responses implicitly available in this inquest through inquest inheritence. effective response view: All response lookup methods return responses where the current date falls in between the effective dates inclusive. any effective response view: responses of any effective date are returned from methods. The methods `useFederatedInquestView()` and `useIsolatedInquestView()` behave as a radio group and one should be selected before invoking any lookup methods. Responses may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the responses.
Method	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupResponses
Description	Tests if this user can perform `Response` 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	useComparativeResponseView
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	usePlenaryResponseView
Description	A complete view of the `Response` 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	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include responses in inquests which are children of this inquest in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this inquest only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveResponseView
Description	Only responses whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveResponseView
Description	All responses of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getResponse
Description	Gets the `Response` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Response` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Response` and retained for compatibility. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`responseId`	the `Id` of the `Response` to retrieve
Return	`osid.inquiry.Response`		the returned `Response`
Errors	NOT_FOUND		no `Response` found with the given `Id`
	NULL_ARGUMENT		`responseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesByIds
Description	Gets a `ResponseList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the responses 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 `Responses` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.IdList`	`responseIds`	the list of `Ids` to retrieve
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`responseIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesByGenusType
Description	Gets a `ResponseList` corresponding to the given response genus `Type` which does not include responses of types derived from the specified `Type.` In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.type.Type`	`responseGenusType`	a response genus type
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NULL_ARGUMENT		`responseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesByParentGenusType
Description	Gets a `ResponseList` corresponding to the given response genus `Type` and include any additional responses with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.type.Type`	`responseGenusType`	a response genus type
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NULL_ARGUMENT		`responseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesByRecordType
Description	Gets a `ResponseList` containing the given response record `Type.` In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.type.Type`	`responseRecordType`	a response record type
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NULL_ARGUMENT		`responseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesOnDate
Description	Gets a list of responses effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.inquiry.ResponseList`		the returned `Response` 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	getResponsesForInquiry
Description	Gets a list of responses for an inquiry. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`inquiry`	an inquiry `Id`
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NULL_ARGUMENT		`inquiry` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesForInquiryOnDate
Description	Gets a list of responses for the given inquiry effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`inquiry`	an inquiry `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`inquiryId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesForResponder
Description	Gets a list of responses for a resource. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.inquiry.ResponseList`		the returned `Response` 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	getResponsesForResponderOnDate
Description	Gets a list of responses for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective responses and those currently expired are returned.
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.inquiry.ResponseList`		the returned `Response` 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	getResponsesForInquiryAndResponder
Description	Gets a list of responses for an inquiry and responder. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`inquiryId`	an inquiry `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	NULL_ARGUMENT		`inquiryId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesForInquiryAndResponderOnDate
Description	Gets a list of responses for an inquiry and responder and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known responses or an error results. Otherwise, the returned list may contain only those responses that are accessible through this session. In effective mode, responses are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective responses and those currently expired are returned.
Parameters	`osid.id.Id`	`inquiryId`	an inquiry `Id`
	`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.inquiry.ResponseList`		the returned `Response` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`inquiryId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResponses
Description	Gets all responses. In plenary mode, the returned list contains all of the responses including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Responses` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, responses are returned that are currently effective. In any effective mode, effective responses and those currently expired are returned.
Return	`osid.inquiry.ResponseList`		the returned `Response` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.