OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryRulesManager
Implementsosid.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:

  • InquiryEnablerLookupSession: a session to retrieve inquiry enablers
  • InquiryEnablerQuerySession: a session to query for inquiry enablers
  • InquiryEnablerSearchSession: a session to search for inquiry enablers
  • InquiryEnablerAdminSession: a session to create and delete inquiry enablers
  • InquiryEnablerNotificationSession: a session to receive notifications pertaining to inquiry enabler changes
  • InquiryEnablerInquestSession: a session to look up inquiry enabler inquest mappings
  • InquiryEnablerInquestAssignmentSession: a session to manage inquiry enabler to inquest mappings
  • InquiryEnablerSmartInquestSession: a session to manage dynamic inquests of inquiry enablers
  • InquiryEnablerRuleLookupSession: a session to look up inquiry enabler mappings
  • InquiryEnablerRuleApplicationSession: a session to apply inquiry enablers
  • AuditEnablerLookupSession: a session to retrieve audit enablers
  • AuditEnablerQuerySession: a session to query for audit enablers
  • AuditEnablerSearchSession: a session to search for audit enablers
  • AuditEnablerAdminSession: a session to create and delete audit enablers
  • AuditEnablerNotificationSession: a session to receive notifications pertaining to audit enabler changes
  • AuditEnablerInquestSession: a session to look up audit enabler inquest mappings
  • AuditEnablerInquestAssignmentSession: a session to manage audit enabler to inquest mappings
  • AuditEnablerSmartInquestSession: a session to manage dynamic inquests of audit enablers
  • AuditEnableRuleLookupSession: a session to look up audit enabler mappings
  • AuditEnablerRuleApplicationSession: a session to apply audit enablers
MethodgetInquiryEnablerLookupSession
Description

Gets the OsidSession associated with the inquiry enabler lookup service.

Returnosid.inquiry.rules.InquiryEnablerLookupSessionan InquiryEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerLookup() is true.
MethodgetInquiryEnablerLookupSessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler lookup service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerLookupSessionan InquiryEnablerLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerLookup() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerQuerySession
Description

Gets the OsidSession associated with the inquiry enabler query service.

Returnosid.inquiry.rules.InquiryEnablerQuerySessionan InquiryEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerQuery() is true.
MethodgetInquiryEnablerQuerySessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler query service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerQuerySessionan InquiryEnablerQuerySession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerQuery() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerSearchSession
Description

Gets the OsidSession associated with the inquiry enabler search service.

Returnosid.inquiry.rules.InquiryEnablerSearchSessionan InquiryEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerSearch() is true.
MethodgetInquiryEnablerSearchSessionForInquest
Description

Gets the OsidSession associated with the inquiry enablers earch service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerSearchSessionan InquiryEnablerSearchSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerSearch() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerAdminSession
Description

Gets the OsidSession associated with the inquiry enabler administration service.

Returnosid.inquiry.rules.InquiryEnablerAdminSessionan InquiryEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerAdmin() is true.
MethodgetInquiryEnablerAdminSessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler administration service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerAdminSessionan InquiryEnablerAdminSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerNotificationSession
Description

Gets the OsidSession associated with the inquiry enabler notification service.

Parametersosid.inquiry.rules.InquiryEnablerReceiverinquiryEnablerReceiverthe notification callback
Returnosid.inquiry.rules.InquiryEnablerNotificationSessionan InquiryEnablerNotificationSession
ErrorsNULL_ARGUMENT inquiryEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerNotification() is true.
MethodgetInquiryEnablerNotificationSessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler notification service for the given inquest.

Parametersosid.inquiry.rules.InquiryEnablerReceiverinquiryEnablerReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerNotificationSessionan InquiryEnablerNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquiryEnablerReceiver or inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerNotification() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerInquestSession
Description

Gets the OsidSession to lookup inquiry enabler/inquest mappings for inquiry enablers.

Returnosid.inquiry.rules.InquiryEnablerInquestSessionan InquiryEnablerInquestSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerInquest() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerInquest() is true.
MethodgetInquiryEnablerInquestAssignmentSession
Description

Gets the OsidSession associated with assigning inquiry enablers to inquests.

Returnosid.inquiry.rules.InquiryEnablerInquestAssignmentSessionan InquiryEnablerInquestAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerInquestAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerInquestAssignment() is true.
MethodgetInquiryEnablerSmartInquestSession
Description

Gets the OsidSession to manage inquiry enabler smart inquests.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerSmartInquestSessionan InquiryEnablerSmartInquestSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerSmartInquest() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerSmartInquest() is true.
MethodgetInquiryEnablerRuleLookupSession
Description

Gets the OsidSession associated with the inquiry enabler mapping lookup service.

Returnosid.inquiry.rules.InquiryEnablerRuleLookupSessionan InquiryEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerRuleLookup() is true.
MethodgetInquiryEnablerRuleLookupSessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler mapping lookup service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerRuleLookupSessionan InquiryEnablerRuleLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetInquiryEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the inquiry enabler assignment service.

Returnosid.inquiry.rules.InquiryEnablerRuleApplicationSessionan InquiryEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerRuleApplication() is true.
MethodgetInquiryEnablerRuleApplicationSessionForInquest
Description

Gets the OsidSession associated with the inquiry enabler assignment service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.InquiryEnablerRuleApplicationSessionan InquiryEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetAuditEnablerLookupSession
Description

Gets the OsidSession associated with the audit enabler lookup service.

Returnosid.inquiry.rules.AuditEnablerLookupSessionan AuditEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerLookup() is true.
MethodgetAuditEnablerLookupSessionForInquest
Description

Gets the OsidSession associated with the audit enabler lookup service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerLookupSessionan AuditEnablerLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerLookup() and supportsVisibleFederation() are true.
MethodgetAuditEnablerQuerySession
Description

Gets the OsidSession associated with the audit enabler query service.

Returnosid.inquiry.rules.AuditEnablerQuerySessionan AuditEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerQuery() is true.
MethodgetAuditEnablerQuerySessionForInquest
Description

Gets the OsidSession associated with the audit enabler query service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerQuerySessionan AuditEnablerQuerySession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerQuery() and supportsVisibleFederation() are true.
MethodgetAuditEnablerSearchSession
Description

Gets the OsidSession associated with the audit enabler search service.

Returnosid.inquiry.rules.AuditEnablerSearchSessionan AuditEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerSearch() is true.
MethodgetAuditEnablerSearchSessionForInquest
Description

Gets the OsidSession associated with the audit enablers earch service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerSearchSessionan AuditEnablerSearchSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerSearch() and supportsVisibleFederation() are true.
MethodgetAuditEnablerAdminSession
Description

Gets the OsidSession associated with the audit enabler administration service.

Returnosid.inquiry.rules.AuditEnablerAdminSessionan AuditEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerAdmin() is true.
MethodgetAuditEnablerAdminSessionForInquest
Description

Gets the OsidSession associated with the audit enabler administration service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerAdminSessionan AuditEnablerAdminSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetAuditEnablerNotificationSession
Description

Gets the OsidSession associated with the audit enabler notification service.

Parametersosid.inquiry.rules.AuditEnablerReceiverauditEnablerReceiverthe notification callback
Returnosid.inquiry.rules.AuditEnablerNotificationSessionan AuditEnablerNotificationSession
ErrorsNULL_ARGUMENT auditEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerNotification() is true.
MethodgetAuditEnablerNotificationSessionForInquest
Description

Gets the OsidSession associated with the audit enabler notification service for the given inquest.

Parametersosid.inquiry.rules.AuditEnablerReceiverauditEnablerReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerNotificationSessionan AuditEnablerNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT auditEnablerReceiver or inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerNotification() and supportsVisibleFederation() are true.
MethodgetAuditEnablerInquestSession
Description

Gets the OsidSession to lookup audit enabler/inquest mappings for audit enablers.

Returnosid.inquiry.rules.AuditEnablerInquestSessionan AuditEnablerInquestSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerInquest() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerInquest() is true.
MethodgetAuditEnablerInquestAssignmentSession
Description

Gets the OsidSession associated with assigning audit enablers to inquests.

Returnosid.inquiry.rules.AuditEnablerInquestAssignmentSessionan AuditEnablerInquestAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerInquestAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerInquestAssignment() is true.
MethodgetAuditEnablerSmartInquestSession
Description

Gets the OsidSession to manage audit enabler smart inquests.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerSmartInquestSessionan AuditEnablerSmartInquestSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerSmartInquest() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerSmartInquest() is true.
MethodgetAuditEnablerRuleLookupSession
Description

Gets the OsidSession associated with the audit enabler mapping lookup service.

Returnosid.inquiry.rules.AuditEnablerRuleLookupSessionan AuditEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerRuleLookup() is true.
MethodgetAuditEnablerRuleLookupSessionForInquest
Description

Gets the OsidSession associated with the audit enabler mapping lookup service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerRuleLookupSessionan AuditEnablerRuleLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetAuditEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the audit enabler assignment service.

Returnosid.inquiry.rules.AuditEnablerRuleApplicationSessionan AuditEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerRuleApplication() is true.
MethodgetAuditEnablerRuleApplicationSessionForInquest
Description

Gets the OsidSession associated with the audit enabler assignment service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.inquiry.rules.AuditEnablerRuleApplicationSessionan AuditEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditEnablerRuleApplication() and supportsVisibleFederation() are true.