OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes inquiry enablers. The data for create and update is provided via the InquiryEnablerForm.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateInquiryEnabler
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.

Returnboolean false if InquiryEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateInquiryEnablerWithRecordTypes
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.

Parametersosid.type.Type[]inquiryEnablerRecordTypesarray of inquiry enabler record types
Returnboolean true if InquiryEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT inquiryEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerFormForCreate
Description

Gets the inquiry enabler form for creating new inquiry enablers. A new form should be requested for each create transinquiry.

Parametersosid.type.Type[]inquiryEnablerRecordTypesarray of inquiry enabler record types
Returnosid.inquiry.rules.InquiryEnablerFormthe inquiry enabler form
ErrorsNULL_ARGUMENT inquiryEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateInquiryEnabler
Description

Creates a new InquiryEnabler.

Parametersosid.inquiry.rules.InquiryEnablerForminquiryEnablerFormthe form for this InquiryEnabler
Returnosid.inquiry.rules.InquiryEnablerthe new InquiryEnabler
ErrorsILLEGAL_STATE inquiryEnablerForm already used in a create transinquiry
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT inquiryEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquiryEnablerForm did not originate from getInquiryEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateInquiryEnablers
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.

Returnboolean false if InquiryEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerFormForUpdate
Description

Gets the inquiry enabler form for updating an existing inquiry enabler. A new inquiry enabler form should be requested for each update transinquiry.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler
Returnosid.inquiry.rules.InquiryEnablerFormthe inquiry enabler form
ErrorsNOT_FOUND inquiryEnablerId is not found
NULL_ARGUMENT inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateInquiryEnabler
Description

Updates an existing inquiry enabler.

Parametersosid.inquiry.rules.InquiryEnablerForminquiryEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE inquiryEnablerForm already used in an update transinquiry
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT inquiryEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquiryEnablerForm did not originate from getInquiryEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteInquiryEnablers
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.

Returnboolean false if InquiryEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteInquiryEnabler
Description

Deletes an InquiryEnabler.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler to remove
ErrorsNOT_FOUND inquiryEnablerId not found
NULL_ARGUMENT inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageInquiryEnablerAliases
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.

Returnboolean false if InquiryEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasInquiryEnabler
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.

Parametersosid.id.IdinquiryEnablerIdthe Id of an InquiryEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND inquiryEnablerId not found
NULL_ARGUMENT inquiryEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.