OSID - osid.inquiry.ResponseAdminSession Service Interface Definition

Interface	osid.inquiry.ResponseAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Responses.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Response,` a `ResponseForm` is requested using `getResponseFormForCreate()` specifying the desired inquiry, resource, and record `Types` or none if no record `Types` are needed. The returned `ResponseForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `ResponseForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ResponseForm` corresponds to an attempted transaction. For updates, `ResponseForms` are requested to the `Response` `Id` that is to be updated using `getResponseFormForUpdate().` Similarly, the `ResponseForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ResponseForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Responses.` To unmap a `Response` from the current `Inquest,` the `ResponseInquestAssignmentSession` should be used. These delete operations attempt to remove the `Response` itself thus removing it from all known `Inquest` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateResponses
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	getResponseFormForCreate
Description	Gets the response form for creating new responses. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` for the inquiry
	`osid.id.Id`	`resourceId`	the `Id` for the responding resource
	`osid.type.Type[]`	`responseRecordTypes`	array of response record types
Return	`osid.inquiry.ResponseForm`		the response form
Errors	NOT_FOUND		`inquiryId` or `resourceId` is not found
	NULL_ARGUMENT		`inquiryId,` `resourceId, 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	createResponse
Description	Creates a new `Response.`
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.
Method	canUpdateResponses
Description	Tests if this user can update responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Response` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Response` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResponseFormForUpdate
Description	Gets the response form for updating an existing response. A new response form should be requested for each update transaction.
Parameters	`osid.id.Id`	`responseId`	the `Id` of the `Response`
Return	`osid.inquiry.ResponseForm`		the response form
Errors	NOT_FOUND		`responseId` is not found
	NULL_ARGUMENT		`responseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateResponse
Description	Updates an existing response.
Parameters	`osid.inquiry.ResponseForm`	`responseForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`responseForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`responseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`responseForm` did not originate from `getResponseFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteResponses
Description	Tests if this user can delete responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Response` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Response` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteResponse
Description	Deletes a `Response.`
Parameters	`osid.id.Id`	`responseId`	the `Id` of the `Response` to remove
Errors	NOT_FOUND		`responseId` not found
	NULL_ARGUMENT		`responseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageResponseAliases
Description	Tests if this user can manage `Id` aliases for `Responses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Response` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasResponse
Description	Adds an `Id` to a `Response` for the purpose of creating compatibility. The primary `Id` of the `Response` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another response, it is reassigned to the given response `Id.`
Parameters	`osid.id.Id`	`responseId`	the `Id` of a `Response`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`responseId` not found
	NULL_ARGUMENT		`responseId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.