| Interface | osid.inquiry.rules.InquiryRulesManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.inquiry.rules.InquiryRulesProfile | |||
| Description |
The inquiry rules manager provides access to inquiry rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getInquiryEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerLookupSession | an InquiryEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerLookup()
is true. | |
| Method | getInquiryEnablerLookupSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerLookupSession | an InquiryEnablerLookupSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getInquiryEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerQuerySession | an InquiryEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerQuery()
is true. | |
| Method | getInquiryEnablerQuerySessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerQuerySession | an InquiryEnablerQuerySession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getInquiryEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerSearchSession | an InquiryEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerSearch()
is true. | |
| Method | getInquiryEnablerSearchSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerSearchSession | an InquiryEnablerSearchSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getInquiryEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerAdminSession | an InquiryEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerAdmin()
is true. | |
| Method | getInquiryEnablerAdminSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerAdminSession | an InquiryEnablerAdminSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getInquiryEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.inquiry.rules.InquiryEnablerReceiver | inquiryEnablerReceiver | the notification callback |
| Return | osid.inquiry.rules.InquiryEnablerNotificationSession | an InquiryEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | inquiryEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerNotification() is true. | |
| Method | getInquiryEnablerNotificationSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.inquiry.rules.InquiryEnablerReceiver | inquiryEnablerReceiver | the notification callback |
osid.id.Id | inquestId | the Id of the Inquest | |
| Return | osid.inquiry.rules.InquiryEnablerNotificationSession | an InquiryEnablerNotificationSession | |
| Errors | NOT_FOUND | no inquest found by the given Id | |
| NULL_ARGUMENT | inquiryEnablerReceiver or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getInquiryEnablerInquestSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerInquestSession | an InquiryEnablerInquestSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerInquest() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryEnablerInquest()
is true. | |
| Method | getInquiryEnablerInquestAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerInquestAssignmentSession | an InquiryEnablerInquestAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerInquestAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerInquestAssignment() is true. | |
| Method | getInquiryEnablerSmartInquestSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerSmartInquestSession | an InquiryEnablerSmartInquestSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerSmartInquest() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerSmartInquest() is true. | |
| Method | getInquiryEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerRuleLookupSession | an InquiryEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerRuleLookup() is true. | |
| Method | getInquiryEnablerRuleLookupSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerRuleLookupSession | an InquiryEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getInquiryEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.InquiryEnablerRuleApplicationSession | an InquiryEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryEnablerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerRuleApplication() is true. | |
| Method | getInquiryEnablerRuleApplicationSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.InquiryEnablerRuleApplicationSession | an InquiryEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsInquiryEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getAuditEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerLookupSession | an AuditEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerLookup()
is true. | |
| Method | getAuditEnablerLookupSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerLookupSession | an AuditEnablerLookupSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getAuditEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerQuerySession | an AuditEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerQuery()
is true. | |
| Method | getAuditEnablerQuerySessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerQuerySession | an AuditEnablerQuerySession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getAuditEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerSearchSession | an AuditEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerSearch()
is true. | |
| Method | getAuditEnablerSearchSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerSearchSession | an AuditEnablerSearchSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getAuditEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerAdminSession | an AuditEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerAdmin()
is true. | |
| Method | getAuditEnablerAdminSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerAdminSession | an AuditEnablerAdminSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getAuditEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.inquiry.rules.AuditEnablerReceiver | auditEnablerReceiver | the notification callback |
| Return | osid.inquiry.rules.AuditEnablerNotificationSession | an AuditEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | auditEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerNotification() is true. | |
| Method | getAuditEnablerNotificationSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.inquiry.rules.AuditEnablerReceiver | auditEnablerReceiver | the notification callback |
osid.id.Id | inquestId | the Id of the Inquest | |
| Return | osid.inquiry.rules.AuditEnablerNotificationSession | an AuditEnablerNotificationSession | |
| Errors | NOT_FOUND | no inquest found by the given Id | |
| NULL_ARGUMENT | auditEnablerReceiver or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getAuditEnablerInquestSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerInquestSession | an AuditEnablerInquestSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerInquest() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerInquest()
is true. | |
| Method | getAuditEnablerInquestAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerInquestAssignmentSession | an AuditEnablerInquestAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerInquestAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerInquestAssignment() is true. | |
| Method | getAuditEnablerSmartInquestSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerSmartInquestSession | an AuditEnablerSmartInquestSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerSmartInquest() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerSmartInquest() is true. | |
| Method | getAuditEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerRuleLookupSession | an AuditEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerRuleLookup()
is true. | |
| Method | getAuditEnablerRuleLookupSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerRuleLookupSession | an AuditEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditEnablerRuleLookup()
and supportsVisibleFederation() are true.
| |
| Method | getAuditEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.rules.AuditEnablerRuleApplicationSession | an AuditEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditEnablerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerRuleApplication() is true. | |
| Method | getAuditEnablerRuleApplicationSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.rules.AuditEnablerRuleApplicationSession | an AuditEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuditEnablerRuleApplication() and
supportsVisibleFederation() are true. | |