OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquiryProxyManager
Implementsosid.OsidProxyManager
osid.inquiry.InquiryProfile
Description

The inquiry proxy manager provides access to inquiry sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

  • AcknowledgementSession: a session for getting and responding to inquiries for authenticated agent
  • AcknowledgementNotificationSession: a session for subscribing to new inquiries for the authenticated agent
  • InquiryLookupSession: a session to retrieve inquiries
  • InquiryQuerySession: a session to query for inquiriess
  • InquirySearchSession: a session to search for inquiries
  • InquiryAdminSession: a session to create and delete inquiries
  • InquiryNotificationSession: a session to receive notifications pertaining to inquiry changes
  • InquiryInquestSession: a session to look up inquiry inquest mappings
  • InquiryInquestAssignmentSession: a session to manage inquiry to inquest mappings
  • InquirySmartInquestSession: a session to manage dynamic inquests of inquiries
  • AuditLookupSession: a session to retrieve audits
  • AuditQuerySession: a session to query for audits
  • AuditSearchSession: a session to search for audits
  • AuditAdminSession: a session to create and delete audits
  • AuditNotificationSession: a session to receive notifications pertaining to audit changes
  • AuditInquestSession: a session to look up audit inquest mappings
  • AuditInquestAssignmentSession: a session to manage audit to inquest mappings
  • AuditSmartInquestSession: a session to manage dynamic inquests of audits
  • ResponseLookupSession: a session to retrieve responses
  • ResponseQuerySession: a session to query for responses
  • ResponseSearchSession: a session to search for responses
  • ResponseAdminSession: a session to create and delete responses
  • ResponseNotificationSession: a session to receive notifications pertaining to response changes
  • ResponseInquestsSession: a session to look up response inquests mappings
  • ResponseInquestAssignmentSession: a session to manage response to inquest mappings
  • ResponseSmartInquestSession: a session to manage dynamic inquests of responses
  • InquestLookupSession: a session to retrieve inquests
  • InquestQuerySession: a session to search for inquests
  • InquestSearchSession: a session to search for inquests
  • InquestAdminSession: a session to create and delete inquests
  • InquestNotificationSession: a session to receive notifications pertaining to inquest changes
  • InquestHierarchySession: a session to traverse a hierarchy of inquest
  • InquestHierarchyDesignSession: a session to manage an inquest hierarchy
MethodgetAcknowledgementSession
Description

Gets the OsidSession associated with the acknowledgement service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AcknowledgementSessionan AcknowledgementSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcknowledgemen() is false
ComplianceoptionalThis method must be implemented if supportsAcknowledgemen() is true.
MethodgetAcknowledgementSessionForInquest
Description

Gets the OsidSession associated with the acknowledgement service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AcknowledgementSessionan AcknowledgementSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcknowledgemen() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAcknowledgemen() and supportsVisibleFederation() are true
MethodgetAcknowledgementNotificationSession
Description

Gets the OsidSession associated with the acknowledgement notification service for resources related to the authenticated agent.

Parametersosid.inquiry.InquiryReceiverinquiryReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AcknowledgementNotificationSessionan AcknowledgementNotificationSession
ErrorsNULL_ARGUMENT inquiryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcknowledgemenNotification() is false
ComplianceoptionalThis method must be implemented if supportsAcknowledgemenNotification() is true.
MethodgetAcknowledgementNotificationSessionForInquest
Description

Gets the OsidSession associated with the acknowledgement notification service for the given inquest for resources related to the authenticated agent.

Parametersosid.inquiry.InquiryReceiverinquiryReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AcknowledgementNotificationSessionan AcknowledgementNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquiryReceiver, inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcknowledgemenNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAcknowledgementNotification() and supportsVisibleFederation() are true
MethodgetInquiryLookupSession
Description

Gets the OsidSession associated with the inquiry lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryLookupSessionan InquiryLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryLookup() is false
ComplianceoptionalThis method must be implemented if supportsInquiryLookup() is true.
MethodgetInquiryLookupSessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryLookupSessionan InquiryLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryLookup() and supportsVisibleFederation() are true
MethodgetInquiryQuerySession
Description

Gets the OsidSession associated with the inquiry query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryQuerySessionan InquiryQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquiryQuery() is true.
MethodgetInquiryQuerySessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryQuerySessionan InquiryQuerySession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryQuery() and supportsVisibleFederation() are true
MethodgetInquirySearchSession
Description

Gets the OsidSession associated with the inquiry search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquirySearchSessionan InquirySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquirySearch() is false
ComplianceoptionalThis method must be implemented if supportsInquirySearch() is true.
MethodgetInquirySearchSessionForInquest
Description

Gets the OsidSession associated with the inquiry search service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquirySearchSessionan InquirySearchSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquirySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquirySearch() and supportsVisibleFederation() are true
MethodgetInquiryAdminSession
Description

Gets the OsidSession associated with the inquiry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryAdminSessionan InquiryAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInquiryAdmin() is true.
MethodgetInquiryAdminSessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryAdminSessionan InquiryAdminSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryAdmin() and supportsVisibleFederation() are true
MethodgetInquiryNotificationSession
Description

Gets the OsidSession associated with the inquiry notification service.

Parametersosid.inquiry.InquiryReceiverinquiryReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryNotificationSessionan InquiryNotificationSession
ErrorsNULL_ARGUMENT inquiryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryNotification() is false
ComplianceoptionalThis method must be implemented if supportsInquiryNotification() is true.
MethodgetInquiryNotificationSessionForInquest
Description

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

Parametersosid.inquiry.InquiryReceiverinquiryReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryNotificationSessionan InquiryNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquiryReceiver, inquestId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryNotification() and supportsVisibleFederation() are true
MethodgetInquiryInquestSession
Description

Gets the OsidSession to lookup inquiry/inquest mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryInquestSessionan InquiryInquestSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryInquest() is false
ComplianceoptionalThis method must be implemented if supportsInquiryInquest() is true.
MethodgetInquiryInquestAssignmentSession
Description

Gets the OsidSession associated with assigning inquiries to inquests.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquiryInquestAssignmentSessionan InquiryInquestAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryInquestAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInquiryInquestAssignment() is true.
MethodgetInquirySmartInquestSession
Description

Gets the OsidSession to manage inquiry smart inquests.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquirySmartInquestSessionan InquirySmartInquestSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquirySmartInquest() is false
ComplianceoptionalThis method must be implemented if supportsInquirySmartInquest() is true.
MethodgetAuditLookupSession
Description

Gets the OsidSession associated with the audit lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditLookupSessionan AuditLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditLookup() is false
ComplianceoptionalThis method must be implemented if supportsAuditLookup() is true.
MethodgetAuditLookupSessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditLookupSessionan AuditLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditLookup() and supportsVisibleFederation() are true
MethodgetAuditQuerySession
Description

Gets the OsidSession associated with the audit query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditQuerySessionan AuditQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuditQuery() is true.
MethodgetAuditQuerySessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditQuerySessionan AuditQuerySession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditQuery() and supportsVisibleFederation() are true
MethodgetAuditSearchSession
Description

Gets the OsidSession associated with the audit search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditSearchSessionan AuditSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditSearch() is false
ComplianceoptionalThis method must be implemented if supportsAuditSearch() is true.
MethodgetAuditSearchSessionForInquest
Description

Gets the OsidSession associated with the audit search service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditSearchSessionan AuditSearchSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditSearch() and supportsVisibleFederation() are true
MethodgetAuditAdminSession
Description

Gets the OsidSession associated with the audit administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditAdminSessionan AuditAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuditAdmin() is true.
MethodgetAuditAdminSessionForInquest
Description

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

Parametersosid.id.IdinquestIdthe Id of the inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditAdminSessionan AuditAdminSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditAdmin() and supportsVisibleFederation() are true
MethodgetAuditNotificationSession
Description

Gets the OsidSession associated with the audit notification service.

Parametersosid.inquiry.AuditReceiverauditReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditNotificationSessionan AuditNotificationSession
ErrorsNULL_ARGUMENT auditReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditNotification() is false
ComplianceoptionalThis method must be implemented if supportsAuditNotification() is true.
MethodgetAuditNotificationSessionForInquest
Description

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

Parametersosid.inquiry.AuditReceiverauditReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditNotificationSessionan AuditNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT auditReceiver, inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditNotification() and supportsVisibleFederation() are true
MethodgetAuditInquestSession
Description

Gets the OsidSession to lookup audit/inquest mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditInquestSessionan AuditInquestSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditInquest() is false
ComplianceoptionalThis method must be implemented if supportsAuditInquest() is true.
MethodgetAuditInquestAssignmentSession
Description

Gets the OsidSession associated with assigning audits to inquests.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditInquestAssignmentSessionan AuditInquestAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditInquestAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAuditInquestAssignment() is true.
MethodgetAuditSmartInquestSession
Description

Gets the OsidSession to manage audit smart inquests.

Parametersosid.id.IdinquestIdthe Id of the inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.AuditSmartInquestSessionan AuditSmartInquestSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditSmartInquest() is false
ComplianceoptionalThis method must be implemented if supportsAuditSmartInquest() is true.
MethodgetResponseLookupSession
Description

Gets the OsidSession associated with the response lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseLookupSessiona ResponseLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseLookup() is false
ComplianceoptionalThis method must be implemented if supportsResponseLookup() is true.
MethodgetResponseLookupSessionForInquest
Description

Gets the OsidSession associated with the response lookup service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseLookupSessiona ResponseLookupSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseLookup() and supportsVisibleFederation() are true.
MethodgetResponseQuerySession
Description

Gets the OsidSession associated with the response query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseQuerySessiona ResponseQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseQuery() is false
ComplianceoptionalThis method must be implemented if supportsResponseQuery() is true.
MethodgetResponseQuerySessionForInquest
Description

Gets the OsidSession associated with the response query service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseQuerySessiona ResponseQuerySession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseQuery() and supportsVisibleFederation() are true.
MethodgetResponseSearchSession
Description

Gets the OsidSession associated with the response search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseSearchSessiona ResponseSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseSearch() is false
ComplianceoptionalThis method must be implemented if supportsResponseSearch() is true.
MethodgetResponseSearchSessionForInquest
Description

Gets the OsidSession associated with the response search service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseSearchSessiona ResponseSearchSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseSearch() and supportsVisibleFederation() are true.
MethodgetResponseAdminSession
Description

Gets the OsidSession associated with the response administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseAdminSessiona ResponseAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseAdmin() is false
ComplianceoptionalThis method must be implemented if supportsResponseAdmin() is true.
MethodgetResponseAdminSessionForInput
Description

Gets the OsidSession associated with the response administration service for the given input.

Parametersosid.id.IdinputIdthe Id of the Input
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseAdminSessiona ResponseAdminSession
ErrorsNOT_FOUNDno input found by the given Id
NULL_ARGUMENT inputId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseAdmin() and supportsVisibleFederation() are true.
MethodgetResponseNotificationSession
Description

Gets the OsidSession associated with the response notification service.

Parametersosid.inquiry.ResponseReceiverresponseReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseNotificationSessiona ResponseNotificationSession
ErrorsNULL_ARGUMENT responseReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseNotification() is false
ComplianceoptionalThis method must be implemented if supportsResponseNotification() is true.
MethodgetResponseNotificationSessionForInquest
Description

Gets the OsidSession associated with the response notification service for the given inquest.

Parametersosid.inquiry.ResponseReceiverresponseReceiverthe notification callback
osid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseNotificationSessiona ResponseNotificationSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT responseReceiver, inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseNotification() and supportsVisibleFederation() are true.
MethodgetResponseInquestSession
Description

Gets the OsidSession to lookup response/inquest mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseInquestSessiona ResponseInquestSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseInquest() is false
ComplianceoptionalThis method must be implemented if supportsResponseInquest() is true.
MethodgetResponseInquestAssignmentSession
Description

Gets the OsidSession associated with assigning responses to inquests.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseInquestAssignmentSessiona ResponseInquestAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseInquestAssignment() is false
ComplianceoptionalThis method must be implemented if supportsResponseInquestAssignment() is true.
MethodgetResponseSmartInquestSession
Description

Gets the OsidSession to manage locatin smart inquests.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.ResponseSmartInquestSessiona ResponseSmartInquestSession
ErrorsNOT_FOUNDno inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseSmartInquest() is false
ComplianceoptionalThis method must be implemented if supportsResponseSmartInquest() is true.
MethodgetInquestLookupSession
Description

Gets the OsidSession associated with the inquest lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestLookupSessionan InquestLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestLookup() is false
ComplianceoptionalThis method must be implemented if supportsInquestLookup() is true.
MethodgetInquestQuerySession
Description

Gets the OsidSession associated with the inquest query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestQuerySessionan InquestQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquestQuery() is true.
MethodgetInquestSearchSession
Description

Gets the OsidSession associated with the inquest search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestSearchSessionan InquestSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestSearch() is false
ComplianceoptionalThis method must be implemented if supportsInquestSearch() is true.
MethodgetInquestAdminSession
Description

Gets the OsidSession associated with the inquest administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestAdminSessionan InquestAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInquestAdmin() is true.
MethodgetInquestNotificationSession
Description

Gets the OsidSession associated with the inquest notification service.

Parametersosid.inquiry.InquestReceiverinquestReceiverthe notification callback
osid.proxy.Proxyproxyan proxy
Returnosid.inquiry.InquestNotificationSessionan InquestNotificationSession
ErrorsNULL_ARGUMENT inquestReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestNotification() is false
ComplianceoptionalThis method must be implemented if supportsInquestNotification() is true.
MethodgetInquestHierarchySession
Description

Gets the OsidSession associated with the inquest hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestHierarchySessionan InquestHierarchySession for inquests
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsInquestHierarchy() is true.
MethodgetInquestHierarchyDesignSession
Description

Gets the OsidSession associated with the inquest hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.InquestHierarchyDesignSessiona HierarchyDesignSession for inquests
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsInquestHierarchyDesign() is true.
MethodgetInquiryBatchProxyManager
Description

Gets the InquiryBatchProxyManager.

Returnosid.inquiry.batch.InquiryBatchProxyManageran InquiryBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryBatch() is false
ComplianceoptionalThis method must be implemented if supportsInquiryBatch() is true.
MethodgetInquiryRulesProxyManager
Description

Gets the InquiryRulesProxyManager.

Returnosid.inquiry.rules.InquiryRulesProxyManageran InquiryRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryRules() is false
ComplianceoptionalThis method must be implemented if supportsInquiryRules() is true.