OSID - osid.inquiry.InquestAdminSession Service Interface Definition

Interface	osid.inquiry.InquestAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Inquests.` 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 an `Inquest,` an `InquestForm` is requested using `getInquestFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `InquestForm` 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 `InquestForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `InquestForm` corresponds to an attempted transaction. For updates, `InquestForms` are requested to the `Inquest` `Id` that is to be updated using `getInquestFormForUpdate().` Similarly, the `InquestForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `InquestForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Inquests.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateInquests
Description	Tests if this user can create `Inquests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Inquest.` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Inquest` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInquestWithRecordTypes
Description	Tests if this user can create a single `Inquest` using the desired record types. While `ControlManager.getInquestRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Inquest.` Providing an empty array tests if an `Inquest` can be created with no records.
Parameters	`osid.type.Type[]`	`inquestRecordTypes`	array of inquest record types
Return	`boolean`		`true` if `Inquest` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquestRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquestFormForCreate
Description	Gets the inquest form for creating new inquests. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`inquestRecordTypes`	array of inquest record types
Return	`osid.inquiry.InquestForm`		the inquest form
Errors	NULL_ARGUMENT		`inquestRecordTypes` 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	createInquest
Description	Creates a new `Inquest.`
Parameters	`osid.inquiry.InquestForm`	`inquestForm`	the form for this `Inquest`
Return	`osid.inquiry.Inquest`		the new `Inquest`
Errors	ILLEGAL_STATE		`inquestForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`inquestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquestForm` did not originate from `getInquestFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateInquests
Description	Tests if this user can update `Inquests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Inquest` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Inquest` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquestFormForUpdate
Description	Gets the inquest form for updating an existing inquest. A new inquest form should be requested for each update transaction.
Parameters	`osid.id.Id`	`inquestId`	the `Id` of the `Inquest`
Return	`osid.inquiry.InquestForm`		the inquest form
Errors	NOT_FOUND		`inquestId` is not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInquest
Description	Updates an existing inquest
Parameters	`osid.inquiry.InquestForm`	`inquestForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`inquestForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`inquestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquestForm` did not originate from `getInquestFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInquests
Description	Tests if this user can delete `Inquests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Inquest` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Inquest` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteInquest
Description	Deletes an `Inquest.`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of the `Inquest` to remove
Errors	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageInquestAliases
Description	Tests if this user can manage `Id` aliases for `Inquests.` 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 `Inquest` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInquest
Description	Adds an `Id` to an `Inquest` for the purpose of creating compatibility. The primary `Id` of the `Inquest` is determined by the provider. The new `Id` performs as an alias to the primary `Id.`
Parameters	`osid.id.Id`	`inquestId`	the `Id` of an `Inquest`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`inquestId` not found
	NULL_ARGUMENT		`inquestId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.