Interface | osid.inquiry.rules.AuditEnablerSmartInquestSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic inquests. An This | ||
Method | getInquestId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Inquest Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquest | ||
Description |
Gets the | ||
Return | osid.inquiry.Inquest | the inquest | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartInquests | ||
Description |
Tests if this user can manage smart inquests. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart inquest management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditEnablerQuery | ||
Description |
Gets an audit enabler query. | ||
Return | osid.inquiry.rules.AuditEnablerQuery | the audit enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditEnablerSearchOrder | ||
Description |
Gets an audit enabler search order. | ||
Return | osid.inquiry.rules.AuditEnablerSearchOrder | the audit enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyAuditEnablerQuery | ||
Description |
Applies an audit enabler query to this inquest. | ||
Parameters | osid.inquiry.rules.AuditEnablerQuery | auditEnablerQuery | the audit enabler query |
Errors | NULL_ARGUMENT | auditEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | auditEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectAuditEnablerQuery | ||
Description |
Gets an audit enabler query inspector for this inquest. | ||
Return | osid.inquiry.rules.AuditEnablerQueryInspector | the audit enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyAuditEnablerSequencing | ||
Description |
Applies an audit enabler search order to this inquest. | ||
Parameters | osid.inquiry.rules.AuditEnablerSearchOrder | auditEnablerSearchOrder | the audit enabler search order |
Errors | NULL_ARGUMENT | auditEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | auditEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditEnablerQueryFromInspector | ||
Description |
Gets an audit enabler query from an inspector. | ||
Parameters | osid.inquiry.rules.AuditEnablerQueryInspector | auditEnablerQueryInspector | an audit enabler query inspector |
Return | osid.inquiry.rules.AuditEnablerQuery | the audit enabler query | |
Errors | NULL_ARGUMENT | auditEnablerQueryInspector is null | |
UNSUPPORTED | auditEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |