org.osid.inquiry

Interface InquiryProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InquiryProfile, OsidProfile, OsidProxyManager, Sourceable

public interface InquiryProxyManager
extends OsidProxyManager, InquiryProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AcknowledgementNotificationSession	getAcknowledgementNotificationSession(InquiryReceiver inquiryReceiver, Proxy proxy) Gets the OsidSession associated with the acknowledgement notification service for resources related to the authenticated agent.
AcknowledgementNotificationSession	getAcknowledgementNotificationSessionForInquest(InquiryReceiver inquiryReceiver, Id inquestId, Proxy proxy) Gets the OsidSession associated with the acknowledgement notification service for the given inquest for resources related to the authenticated agent.
AcknowledgementSession	getAcknowledgementSession(Proxy proxy) Gets the OsidSession associated with the acknowledgement service.
AcknowledgementSession	getAcknowledgementSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the acknowledgement service for the given inquest.
AuditAdminSession	getAuditAdminSession(Proxy proxy) Gets the OsidSession associated with the audit administration service.
AuditAdminSession	getAuditAdminSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the audit administration service for the given inquest.
AuditInquestAssignmentSession	getAuditInquestAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning audits to inquests.
AuditInquestSession	getAuditInquestSession(Proxy proxy) Gets the OsidSession to lookup audit/inquest mappings.
AuditLookupSession	getAuditLookupSession(Proxy proxy) Gets the OsidSession associated with the audit lookup service.
AuditLookupSession	getAuditLookupSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the audit lookup service for the given inquest.
AuditNotificationSession	getAuditNotificationSession(AuditReceiver auditReceiver, Proxy proxy) Gets the OsidSession associated with the audit notification service.
AuditNotificationSession	getAuditNotificationSessionForInquest(AuditReceiver auditReceiver, Id inquestId, Proxy proxy) Gets the OsidSession associated with the audit notification service for the given inquest.
AuditQuerySession	getAuditQuerySession(Proxy proxy) Gets the OsidSession associated with the audit query service.
AuditQuerySession	getAuditQuerySessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the audit query service for the given inquest.
AuditSearchSession	getAuditSearchSession(Proxy proxy) Gets the OsidSession associated with the audit search service.
AuditSearchSession	getAuditSearchSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the audit search service for the given inquest.
AuditSmartInquestSession	getAuditSmartInquestSession(Id inquestId, Proxy proxy) Gets the OsidSession to manage audit smart inquests.
InquestAdminSession	getInquestAdminSession(Proxy proxy) Gets the OsidSession associated with the inquest administrative service.
InquestHierarchyDesignSession	getInquestHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the inquest hierarchy design service.
InquestHierarchySession	getInquestHierarchySession(Proxy proxy) Gets the OsidSession associated with the inquest hierarchy service.
InquestLookupSession	getInquestLookupSession(Proxy proxy) Gets the OsidSession associated with the inquest lookup service.
InquestNotificationSession	getInquestNotificationSession(InquestReceiver inquestReceiver, Proxy proxy) Gets the OsidSession associated with the inquest notification service.
InquestQuerySession	getInquestQuerySession(Proxy proxy) Gets the OsidSession associated with the inquest query service.
InquestSearchSession	getInquestSearchSession(Proxy proxy) Gets the OsidSession associated with the inquest search service.
InquiryAdminSession	getInquiryAdminSession(Proxy proxy) Gets the OsidSession associated with the inquiry administration service.
InquiryAdminSession	getInquiryAdminSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the inquiry administration service for the given inquest.
InquiryBatchProxyManager	getInquiryBatchProxyManager() Gets the InquiryBatchProxyManager.
InquiryInquestAssignmentSession	getInquiryInquestAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning inquiries to inquests.
InquiryInquestSession	getInquiryInquestSession(Proxy proxy) Gets the OsidSession to lookup inquiry/inquest mappings.
InquiryLookupSession	getInquiryLookupSession(Proxy proxy) Gets the OsidSession associated with the inquiry lookup service.
InquiryLookupSession	getInquiryLookupSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the inquiry lookup service for the given inquest.
InquiryNotificationSession	getInquiryNotificationSession(InquiryReceiver inquiryReceiver, Proxy proxy) Gets the OsidSession associated with the inquiry notification service.
InquiryNotificationSession	getInquiryNotificationSessionForInquest(InquiryReceiver inquiryReceiver, Id inquestId, Proxy proxy) Gets the OsidSession associated with the inquiry notification service for the given inquest.
InquiryQuerySession	getInquiryQuerySession(Proxy proxy) Gets the OsidSession associated with the inquiry query service.
InquiryQuerySession	getInquiryQuerySessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the inquiry query service for the given inquest.
InquiryRulesProxyManager	getInquiryRulesProxyManager() Gets the InquiryRulesProxyManager.
InquirySearchSession	getInquirySearchSession(Proxy proxy) Gets the OsidSession associated with the inquiry search service.
InquirySearchSession	getInquirySearchSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the inquiry search service for the given inquest.
InquirySmartInquestSession	getInquirySmartInquestSession(Id inquestId, Proxy proxy) Gets the OsidSession to manage inquiry smart inquests.
ResponseAdminSession	getResponseAdminSession(Proxy proxy) Gets the OsidSession associated with the response administration service.
ResponseAdminSession	getResponseAdminSessionForInput(Id inputId, Proxy proxy) Gets the OsidSession associated with the response administration service for the given input.
ResponseInquestAssignmentSession	getResponseInquestAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning responses to inquests.
ResponseInquestSession	getResponseInquestSession(Proxy proxy) Gets the OsidSession to lookup response/inquest mappings.
ResponseLookupSession	getResponseLookupSession(Proxy proxy) Gets the OsidSession associated with the response lookup service.
ResponseLookupSession	getResponseLookupSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the response lookup service for the given inquest.
ResponseNotificationSession	getResponseNotificationSession(ResponseReceiver responseReceiver, Proxy proxy) Gets the OsidSession associated with the response notification service.
ResponseNotificationSession	getResponseNotificationSessionForInquest(ResponseReceiver responseReceiver, Id inquestId, Proxy proxy) Gets the OsidSession associated with the response notification service for the given inquest.
ResponseQuerySession	getResponseQuerySession(Proxy proxy) Gets the OsidSession associated with the response query service.
ResponseQuerySession	getResponseQuerySessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the response query service for the given inquest.
ResponseSearchSession	getResponseSearchSession(Proxy proxy) Gets the OsidSession associated with the response search service.
ResponseSearchSession	getResponseSearchSessionForInquest(Id inquestId, Proxy proxy) Gets the OsidSession associated with the response search service for the given inquest.
ResponseSmartInquestSession	getResponseSmartInquestSession(Id inquestId, Proxy proxy) Gets the OsidSession to manage locatin smart inquests.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.inquiry.InquiryProfile

getAuditRecordTypes, getAuditSearchRecordTypes, getInquestRecordTypes, getInquestSearchRecordTypes, getInquiryRecordTypes, getInquirySearchRecordTypes, getResponseRecordTypes, getResponseSearchRecordTypes, supportsAcknowledgement, supportsAcknowledgementNotification, supportsAuditAdmin, supportsAuditInquest, supportsAuditInquestAssignment, supportsAuditLookup, supportsAuditNotification, supportsAuditQuery, supportsAuditRecordType, supportsAuditSearch, supportsAuditSearchRecordType, supportsAuditSmartInquest, supportsInquestAdmin, supportsInquestHierarchy, supportsInquestHierarchyDesign, supportsInquestLookup, supportsInquestNotification, supportsInquestQuery, supportsInquestRecordType, supportsInquestSearch, supportsInquestSearchRecordType, supportsInquiryAdmin, supportsInquiryBatch, supportsInquiryInquest, supportsInquiryInquestAssignment, supportsInquiryLookup, supportsInquiryNotification, supportsInquiryQuery, supportsInquiryRecordType, supportsInquiryRules, supportsInquirySearch, supportsInquirySearchRecordType, supportsInquirySmartInquest, supportsResponseAdmin, supportsResponseInquest, supportsResponseInquestAssignment, supportsResponseLookup, supportsResponseNotification, supportsResponseQuery, supportsResponseRecordType, supportsResponseSearch, supportsResponseSearchRecordType, supportsResponseSmartInquest, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAcknowledgementSession

AcknowledgementSession getAcknowledgementSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the acknowledgement service.

Parameters:

proxy - a proxy

Returns:

an AcknowledgementSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgemen() is false

Compliance:

optional - This method must be implemented if supportsAcknowledgemen() is true.

getAcknowledgementSessionForInquest

AcknowledgementSession getAcknowledgementSessionForInquest(Id inquestId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AcknowledgementSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgemen() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAcknowledgemen() and supportsVisibleFederation() are true

getAcknowledgementNotificationSession

AcknowledgementNotificationSession getAcknowledgementNotificationSession(InquiryReceiver inquiryReceiver,
                                                                       Proxy proxy)
                                                                         throws OperationFailedException

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

Parameters:

inquiryReceiver - the notification callback

proxy - a proxy

Returns:

an AcknowledgementNotificationSession

Throws:

NullArgumentException - inquiryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgemenNotification() is false

Compliance:

optional - This method must be implemented if supportsAcknowledgemenNotification() is true.

getAcknowledgementNotificationSessionForInquest

AcknowledgementNotificationSession getAcknowledgementNotificationSessionForInquest(InquiryReceiver inquiryReceiver,
                                                                                 Id inquestId,
                                                                                 Proxy proxy)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

inquiryReceiver - the notification callback

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AcknowledgementNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquiryReceiver, inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgemenNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAcknowledgementNotification() and supportsVisibleFederation() are true

getInquiryLookupSession

InquiryLookupSession getInquiryLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the inquiry lookup service.

Parameters:

proxy - a proxy

Returns:

an InquiryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryLookup() is false

Compliance:

optional - This method must be implemented if supportsInquiryLookup() is true.

getInquiryLookupSessionForInquest

InquiryLookupSession getInquiryLookupSessionForInquest(Id inquestId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquiryLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquiryLookup() and supportsVisibleFederation() are true

getInquiryQuerySession

InquiryQuerySession getInquiryQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the inquiry query service.

Parameters:

proxy - a proxy

Returns:

an InquiryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryQuery() is false

Compliance:

optional - This method must be implemented if supportsInquiryQuery() is true.

getInquiryQuerySessionForInquest

InquiryQuerySession getInquiryQuerySessionForInquest(Id inquestId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquiryQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquiryQuery() and supportsVisibleFederation() are true

getInquirySearchSession

InquirySearchSession getInquirySearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the inquiry search service.

Parameters:

proxy - a proxy

Returns:

an InquirySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquirySearch() is false

Compliance:

optional - This method must be implemented if supportsInquirySearch() is true.

getInquirySearchSessionForInquest

InquirySearchSession getInquirySearchSessionForInquest(Id inquestId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquirySearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquirySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquirySearch() and supportsVisibleFederation() are true

getInquiryAdminSession

InquiryAdminSession getInquiryAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the inquiry administration service.

Parameters:

proxy - a proxy

Returns:

an InquiryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryAdmin() is false

Compliance:

optional - This method must be implemented if supportsInquiryAdmin() is true.

getInquiryAdminSessionForInquest

InquiryAdminSession getInquiryAdminSessionForInquest(Id inquestId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inquestId - the Id of the inquest

proxy - a proxy

Returns:

an InquiryAdminSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquiryAdmin() and supportsVisibleFederation() are true

getInquiryNotificationSession

InquiryNotificationSession getInquiryNotificationSession(InquiryReceiver inquiryReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the inquiry notification service.

Parameters:

inquiryReceiver - the notification callback

proxy - a proxy

Returns:

an InquiryNotificationSession

Throws:

NullArgumentException - inquiryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryNotification() is false

Compliance:

optional - This method must be implemented if supportsInquiryNotification() is true.

getInquiryNotificationSessionForInquest

InquiryNotificationSession getInquiryNotificationSessionForInquest(InquiryReceiver inquiryReceiver,
                                                                 Id inquestId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

inquiryReceiver - the notification callback

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquiryNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquiryReceiver, inquestId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquiryNotification() and supportsVisibleFederation() are true

getInquiryInquestSession

InquiryInquestSession getInquiryInquestSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession to lookup inquiry/inquest mappings.

Parameters:

proxy - a proxy

Returns:

an InquiryInquestSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryInquest() is false

Compliance:

optional - This method must be implemented if supportsInquiryInquest() is true.

getInquiryInquestAssignmentSession

InquiryInquestAssignmentSession getInquiryInquestAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning inquiries to inquests.

Parameters:

proxy - a proxy

Returns:

an InquiryInquestAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryInquestAssignment() is false

Compliance:

optional - This method must be implemented if supportsInquiryInquestAssignment() is true.

getInquirySmartInquestSession

InquirySmartInquestSession getInquirySmartInquestSession(Id inquestId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession to manage inquiry smart inquests.

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquirySmartInquestSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquirySmartInquest() is false

Compliance:

optional - This method must be implemented if supportsInquirySmartInquest() is true.

getAuditLookupSession

AuditLookupSession getAuditLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the audit lookup service.

Parameters:

proxy - a proxy

Returns:

an AuditLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditLookup() is false

Compliance:

optional - This method must be implemented if supportsAuditLookup() is true.

getAuditLookupSessionForInquest

AuditLookupSession getAuditLookupSessionForInquest(Id inquestId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AuditLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditLookup() and supportsVisibleFederation() are true

getAuditQuerySession

AuditQuerySession getAuditQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the audit query service.

Parameters:

proxy - a proxy

Returns:

an AuditQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditQuery() is false

Compliance:

optional - This method must be implemented if supportsAuditQuery() is true.

getAuditQuerySessionForInquest

AuditQuerySession getAuditQuerySessionForInquest(Id inquestId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AuditQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditQuery() and supportsVisibleFederation() are true

getAuditSearchSession

AuditSearchSession getAuditSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the audit search service.

Parameters:

proxy - a proxy

Returns:

an AuditSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditSearch() is false

Compliance:

optional - This method must be implemented if supportsAuditSearch() is true.

getAuditSearchSessionForInquest

AuditSearchSession getAuditSearchSessionForInquest(Id inquestId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AuditSearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditSearch() and supportsVisibleFederation() are true

getAuditAdminSession

AuditAdminSession getAuditAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the audit administration service.

Parameters:

proxy - a proxy

Returns:

an AuditAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditAdmin() is false

Compliance:

optional - This method must be implemented if supportsAuditAdmin() is true.

getAuditAdminSessionForInquest

AuditAdminSession getAuditAdminSessionForInquest(Id inquestId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

inquestId - the Id of the inquest

proxy - a proxy

Returns:

an AuditAdminSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditAdmin() and supportsVisibleFederation() are true

getAuditNotificationSession

AuditNotificationSession getAuditNotificationSession(AuditReceiver auditReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the audit notification service.

Parameters:

auditReceiver - the notification callback

proxy - a proxy

Returns:

an AuditNotificationSession

Throws:

NullArgumentException - auditReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditNotification() is false

Compliance:

optional - This method must be implemented if supportsAuditNotification() is true.

getAuditNotificationSessionForInquest

AuditNotificationSession getAuditNotificationSessionForInquest(AuditReceiver auditReceiver,
                                                             Id inquestId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

auditReceiver - the notification callback

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AuditNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - auditReceiver, inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditNotification() and supportsVisibleFederation() are true

getAuditInquestSession

AuditInquestSession getAuditInquestSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession to lookup audit/inquest mappings.

Parameters:

proxy - a proxy

Returns:

an AuditInquestSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditInquest() is false

Compliance:

optional - This method must be implemented if supportsAuditInquest() is true.

getAuditInquestAssignmentSession

AuditInquestAssignmentSession getAuditInquestAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning audits to inquests.

Parameters:

proxy - a proxy

Returns:

an AuditInquestAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditInquestAssignment() is false

Compliance:

optional - This method must be implemented if supportsAuditInquestAssignment() is true.

getAuditSmartInquestSession

AuditSmartInquestSession getAuditSmartInquestSession(Id inquestId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession to manage audit smart inquests.

Parameters:

inquestId - the Id of the inquest

proxy - a proxy

Returns:

an AuditSmartInquestSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditSmartInquest() is false

Compliance:

optional - This method must be implemented if supportsAuditSmartInquest() is true.

getResponseLookupSession

ResponseLookupSession getResponseLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the response lookup service.

Parameters:

proxy - a proxy

Returns:

a ResponseLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseLookup() is false

Compliance:

optional - This method must be implemented if supportsResponseLookup() is true.

getResponseLookupSessionForInquest

ResponseLookupSession getResponseLookupSessionForInquest(Id inquestId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

inquestId - the Id of the inquest

proxy - a proxy

Returns:

a ResponseLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseLookup() and supportsVisibleFederation() are true.

getResponseQuerySession

ResponseQuerySession getResponseQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the response query service.

Parameters:

proxy - a proxy

Returns:

a ResponseQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseQuery() is false

Compliance:

optional - This method must be implemented if supportsResponseQuery() is true.

getResponseQuerySessionForInquest

ResponseQuerySession getResponseQuerySessionForInquest(Id inquestId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

a ResponseQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseQuery() and supportsVisibleFederation() are true.

getResponseSearchSession

ResponseSearchSession getResponseSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the response search service.

Parameters:

proxy - a proxy

Returns:

a ResponseSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseSearch() is false

Compliance:

optional - This method must be implemented if supportsResponseSearch() is true.

getResponseSearchSessionForInquest

ResponseSearchSession getResponseSearchSessionForInquest(Id inquestId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

a ResponseSearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseSearch() and supportsVisibleFederation() are true.

getResponseAdminSession

ResponseAdminSession getResponseAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the response administration service.

Parameters:

proxy - a proxy

Returns:

a ResponseAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseAdmin() is false

Compliance:

optional - This method must be implemented if supportsResponseAdmin() is true.

getResponseAdminSessionForInput

ResponseAdminSession getResponseAdminSessionForInput(Id inputId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inputId - the Id of the Input

proxy - a proxy

Returns:

a ResponseAdminSession

Throws:

NotFoundException - no input found by the given Id

NullArgumentException - inputId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseAdmin() and supportsVisibleFederation() are true.

getResponseNotificationSession

ResponseNotificationSession getResponseNotificationSession(ResponseReceiver responseReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the response notification service.

Parameters:

responseReceiver - the notification callback

proxy - a proxy

Returns:

a ResponseNotificationSession

Throws:

NullArgumentException - responseReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseNotification() is false

Compliance:

optional - This method must be implemented if supportsResponseNotification() is true.

getResponseNotificationSessionForInquest

ResponseNotificationSession getResponseNotificationSessionForInquest(ResponseReceiver responseReceiver,
                                                                   Id inquestId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

responseReceiver - the notification callback

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

a ResponseNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - responseReceiver, inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseNotification() and supportsVisibleFederation() are true.

getResponseInquestSession

ResponseInquestSession getResponseInquestSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession to lookup response/inquest mappings.

Parameters:

proxy - a proxy

Returns:

a ResponseInquestSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseInquest() is false

Compliance:

optional - This method must be implemented if supportsResponseInquest() is true.

getResponseInquestAssignmentSession

ResponseInquestAssignmentSession getResponseInquestAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning responses to inquests.

Parameters:

proxy - a proxy

Returns:

a ResponseInquestAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseInquestAssignment() is false

Compliance:

optional - This method must be implemented if supportsResponseInquestAssignment() is true.

getResponseSmartInquestSession

ResponseSmartInquestSession getResponseSmartInquestSession(Id inquestId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession to manage locatin smart inquests.

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

a ResponseSmartInquestSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseSmartInquest() is false

Compliance:

optional - This method must be implemented if supportsResponseSmartInquest() is true.

getInquestLookupSession

InquestLookupSession getInquestLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the inquest lookup service.

Parameters:

proxy - a proxy

Returns:

an InquestLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestLookup() is false

Compliance:

optional - This method must be implemented if supportsInquestLookup() is true.

getInquestQuerySession

InquestQuerySession getInquestQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the inquest query service.

Parameters:

proxy - a proxy

Returns:

an InquestQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestQuery() is false

Compliance:

optional - This method must be implemented if supportsInquestQuery() is true.

getInquestSearchSession

InquestSearchSession getInquestSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the inquest search service.

Parameters:

proxy - a proxy

Returns:

an InquestSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestSearch() is false

Compliance:

optional - This method must be implemented if supportsInquestSearch() is true.

getInquestAdminSession

InquestAdminSession getInquestAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the inquest administrative service.

Parameters:

proxy - a proxy

Returns:

an InquestAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestAdmin() is false

Compliance:

optional - This method must be implemented if supportsInquestAdmin() is true.

getInquestNotificationSession

InquestNotificationSession getInquestNotificationSession(InquestReceiver inquestReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the inquest notification service.

Parameters:

inquestReceiver - the notification callback

proxy - an proxy

Returns:

an InquestNotificationSession

Throws:

NullArgumentException - inquestReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestNotification() is false

Compliance:

optional - This method must be implemented if supportsInquestNotification() is true.

getInquestHierarchySession

InquestHierarchySession getInquestHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the inquest hierarchy service.

Parameters:

proxy - a proxy

Returns:

an InquestHierarchySession for inquests

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestHierarchy() is false

Compliance:

optional - This method must be implemented if supportsInquestHierarchy() is true.

getInquestHierarchyDesignSession

InquestHierarchyDesignSession getInquestHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the inquest hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for inquests

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsInquestHierarchyDesign() is true.

getInquiryBatchProxyManager

InquiryBatchProxyManager getInquiryBatchProxyManager()
                                                     throws OperationFailedException

Gets the InquiryBatchProxyManager.

Returns:

an InquiryBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryBatch() is false

Compliance:

optional - This method must be implemented if supportsInquiryBatch() is true.

getInquiryRulesProxyManager

InquiryRulesProxyManager getInquiryRulesProxyManager()
                                                     throws OperationFailedException

Gets the InquiryRulesProxyManager.

Returns:

an InquiryRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryRules() is false

Compliance:

optional - This method must be implemented if supportsInquiryRules() is true.