OSID - osid.inquiry.AcknowledgementSession Service Interface Definition

Interface	osid.inquiry.AcknowledgementSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session defines methods for evaluating and responding to inquiries for users.
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	canGetMyInquiries
Description	Tests if this user can perform `Inquiry` 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	getMyInquiries
Description	Gets the inquiries needing a response for the resource related to this agent.
Parameters	`osid.id.Id`	`auditId`	the `Id` of an `Audit`
Return	`osid.inquiry.InquiryList`		the returned `InquiryList`
Errors	NULL_ARGUMENT		`auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRespond
Description	Tests if this user can create responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Response` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Response` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResponseWithRecordTypes
Description	Tests if this user can create a single `Response` using the desired record types. While `ControlManager.getResponseRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Response`. Providing an empty array tests if a `Response` can be created with no records.
Parameters	`osid.type.Type[]`	`responseRecordTypes`	array of response record types
Return	`boolean`		`true` if `Response` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`responseRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResponseForm
Description	Gets the response form for creating new responses from this agent. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` for the inquiry
Parameters	`osid.type.Type[]`	`responseRecordTypes`	array of response record types
Return	`osid.inquiry.ResponseForm`		the response form
Errors	NOT_FOUND		`inquiryId` is not found
	NULL_ARGUMENT		`inquiryId` or `responseRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	respond
Description	Creates a new `Response` from this agent.
Parameters	`osid.inquiry.ResponseForm`	`responseForm`	the form for this `Response`
Return	`osid.inquiry.Response`		the new `Response`
Errors	ILLEGAL_STATE		`responseForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`responseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`responseForm` did not originate from `getResponseFormForCreate()`
Compliance	`mandatory`		This method must be implemented.