OSID - osid.inquiry.InquiryAdminSession Service Interface Definition

Interface	osid.inquiry.InquiryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.inquiry.batch.InquiryBatchAdminSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session creates, updates, and deletes `Inquiries`. 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 `Inquiry`, an `InquiryForm` is requested using `getInquiryFormForCreate()` specifying the desired audit and record `Types` or none if no record `Types` are needed. The returned `InquiryForm` 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 `InquiryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `InquiryForm` corresponds to an attempted transaction. For updates, `InquiryForms` are requested to the `Inquiry` `Id` that is to be updated using `getInquiryFormForUpdate()`. Similarly, the `InquiryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `InquiryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Inquiries`. To unmap an `Inquiry` from the current `Inquest`, the `InquiryInquestAssignmentSession` should be used. These delete operations attempt to remove the `Inquiry` 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	canCreateInquiries
Description	Tests if this user can create `Inquiries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Inquiry` 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 `Inquiry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInquiryWithRecordTypes
Description	Tests if this user can create a single `Inquiry` using the desired record types. While `InquiryManager.getInquiryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Inquiry`. Providing an empty array tests if an `Inquiry` can be created with no records.
Parameters	`osid.type.Type[]`	`inquiryRecordTypes`	array of inquiry record types
Return	`boolean`		`true` if `Inquiry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquiryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryFormForCreate
Description	Gets the inquiry form for creating new inquiries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`auditId`	the `Id` for the audit
Parameters	`osid.type.Type[]`	`inquiryRecordTypes`	array of inquiry record types
Return	`osid.inquiry.InquiryForm`		the inquiry form
Errors	NOT_FOUND		`auditId` is not found
	NULL_ARGUMENT		`auditId` or `inquiryRecordTypes` 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	createInquiry
Description	Creates a new `Inquiry`.
Parameters	`osid.inquiry.InquiryForm`	`inquiryForm`	the form for this `Inquiry`
Return	`osid.inquiry.Inquiry`		the new `Inquiry`
Errors	ILLEGAL_STATE		`inquiryForm` already used in a create transaction.
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`inquiryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquiryForm` did not originate from `getInquiryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateInquiries
Description	Tests if this user can update `Inquiries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Inquiry` 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 `Inquiry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryFormForUpdate
Description	Gets the inquiry form for updating an existing inquiry. A new inquiry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of the `Inquiry`
Return	`osid.inquiry.InquiryForm`		the inquiry form
Errors	NOT_FOUND		`inquiryId` is not found
	NULL_ARGUMENT		`inquiryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInquiry
Description	Updates an existing inquiry.
Parameters	`osid.inquiry.InquiryForm`	`inquiryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`inquiryForm` already used in an update transatcion
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`inquiryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquiryForm` did not originate from `getInquiryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInquiries
Description	Tests if this user can delete `Inquiries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Inquiry` 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 `Inquiry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteInquiry
Description	Deletes an `Inquiry`.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of the `Inquiry` to remove
Errors	NOT_FOUND		`inquiryId` not found
	NULL_ARGUMENT		`inquiryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageInquiryAliases
Description	Tests if this user can manage `Id` aliases for `Inquiries`. 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 `Inquiry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInquiry
Description	Adds an `Id` to an `Inquiry` for the purpose of creating compatibility. The primary `Id` of the `Inquiry` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another inquiry, it is reassigned to the given inquiry `Id`.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of an `Inquiry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`inquiryId` not found
	NULL_ARGUMENT		`inquiryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceInquiries
Description	Tests if this user can order `Inquiries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `Inquiry` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveInquiryAhead
Description	Reorders inquiries in an audit by moving the specified inquiry in front of a reference inquiry.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of an `Inquiry`
	`osid.id.Id`	`auditId`	the `Id` of an `Audit`
	`osid.id.Id`	`referenceId`	the reference inquiry `Id`
Errors	NOT_FOUND		`inquiryId, auditId`, or `referenceId` not found or, `inquiryId` or `referenceId` not related to `auditId`
	NULL_ARGUMENT		`inquiryId, auditId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveInquiryBehind
Description	Reorders inquiries in an audit by moving the specified inquiry behind a reference inquiry.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of an `Inquiry`
	`osid.id.Id`	`auditId`	the `Id` of an `Audit`
	`osid.id.Id`	`referenceId`	the reference inquiry `Id`
Errors	NOT_FOUND		`inquiryId, auditId`, or `referenceId` not found or, `inquiryId` or `referenceId` not related to `auditId`
	NULL_ARGUMENT		`inquiryId, auditId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderInquiries
Description	Reorders a set of inquiries in an audit.
Parameters	`osid.id.Id[]`	`inquiryIds`	the `Ids` for a set of `Inquiries`
Parameters	`osid.id.Id`	`auditId`	the `Id` of an `Audit`
Errors	NOT_FOUND		`auditId` not found or, an `inquiryId` not related to `auditId`
	NULL_ARGUMENT		`inquiryIds` or `auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.