OSID - osid.inquiry.rules.InquiryEnablerAdminSession Service Interface Definition

Interface	osid.inquiry.rules.InquiryEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session creates and removes inquiry enablers. The data for create and update is provided via the `InquiryEnablerForm`.
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	canCreateInquiryEnabler
Description	Tests if this user can create inquiry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `InquiryEnabler` 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 `InquiryEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInquiryEnablerWithRecordTypes
Description	Tests if this user can create a single `InquiryEnabler` using the desired record types. While `InquiryRulesManager.getInquiryEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `InquiryEnabler`. Providing an empty array tests if an `InquiryEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`inquiryEnablerRecordTypes`	array of inquiry enabler record types
Return	`boolean`		`true` if `InquiryEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquiryEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablerFormForCreate
Description	Gets the inquiry enabler form for creating new inquiry enablers. A new form should be requested for each create transinquiry.
Parameters	`osid.type.Type[]`	`inquiryEnablerRecordTypes`	array of inquiry enabler record types
Return	`osid.inquiry.rules.InquiryEnablerForm`		the inquiry enabler form
Errors	NULL_ARGUMENT		`inquiryEnablerRecordTypes` 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	createInquiryEnabler
Description	Creates a new `InquiryEnabler`.
Parameters	`osid.inquiry.rules.InquiryEnablerForm`	`inquiryEnablerForm`	the form for this `InquiryEnabler`
Return	`osid.inquiry.rules.InquiryEnabler`		the new `InquiryEnabler`
Errors	ILLEGAL_STATE		`inquiryEnablerForm` already used in a create transinquiry
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`inquiryEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquiryEnablerForm did not originate from getInquiryEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateInquiryEnablers
Description	Tests if this user can update inquiry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `InquiryEnabler` 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 `InquiryEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryEnablerFormForUpdate
Description	Gets the inquiry enabler form for updating an existing inquiry enabler. A new inquiry enabler form should be requested for each update transinquiry.
Parameters	`osid.id.Id`	`inquiryEnablerId`	the `Id` of the `InquiryEnabler`
Return	`osid.inquiry.rules.InquiryEnablerForm`		the inquiry enabler form
Errors	NOT_FOUND		`inquiryEnablerId` is not found
	NULL_ARGUMENT		`inquiryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInquiryEnabler
Description	Updates an existing inquiry enabler.
Parameters	`osid.inquiry.rules.InquiryEnablerForm`	`inquiryEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`inquiryEnablerForm` already used in an update transinquiry
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`inquiryEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inquiryEnablerForm` did not originate from `getInquiryEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInquiryEnablers
Description	Tests if this user can delete inquiry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `InquiryEnabler` 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 `InquiryEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteInquiryEnabler
Description	Deletes an `InquiryEnabler`.
Parameters	`osid.id.Id`	`inquiryEnablerId`	the `Id` of the `InquiryEnabler` to remove
Errors	NOT_FOUND		`inquiryEnablerId` not found
	NULL_ARGUMENT		`inquiryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageInquiryEnablerAliases
Description	Tests if this user can manage `Id` aliases for inquiry enablers. 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 `InquiryEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInquiryEnabler
Description	Adds an `Id` to an `InquiryEnabler` for the purpose of creating compatibility. The primary `Id` of the `InquiryEnabler` 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 enabler. it is reassigned to the given inquiry enabler `Id`.
Parameters	`osid.id.Id`	`inquiryEnablerId`	the `Id` of an `InquiryEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`inquiryEnablerId` not found
	NULL_ARGUMENT		`inquiryEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.