org.osid.inquiry

Interface InquiryManager

All Superinterfaces:

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

public interface InquiryManager
extends OsidManager, InquiryProfile

The inquiry manager provides access to inquiry sessions and provides interoperability tests for various aspects of this service. 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) Gets the OsidSession associated with the acknowledgement notification service for inquiries related to the authentciated agent.
AcknowledgementNotificationSession	getAcknowledgementNotificationSessionForInquest(InquiryReceiver inquiryReceiver, Id inquestId) Gets the OsidSession associated with the acknowledgement notification service for the given inquest for inquiries related to the authentciated agent.
AcknowledgementSession	getAcknowledgementSession() Gets the OsidSession associated with the acknowledgement service.
AcknowledgementSession	getAcknowledgementSessionForInquest(Id inquestId) Gets the OsidSession associated with the acknowledgement service for the given inquest.
AuditAdminSession	getAuditAdminSession() Gets the OsidSession associated with the audit administration service.
AuditAdminSession	getAuditAdminSessionForInquest(Id inquestId) Gets the OsidSession associated with the audit administration service for the given inquest.
AuditInquestAssignmentSession	getAuditInquestAssignmentSession() Gets the OsidSession associated with assigning audits to inquests.
AuditInquestSession	getAuditInquestSession() Gets the OsidSession to lookup audit/inquest mappings.
AuditLookupSession	getAuditLookupSession() Gets the OsidSession associated with the audit lookup service.
AuditLookupSession	getAuditLookupSessionForInquest(Id inquestId) Gets the OsidSession associated with the audit lookup service for the given inquest.
AuditNotificationSession	getAuditNotificationSession(AuditReceiver auditReceiver) Gets the OsidSession associated with the audit notification service.
AuditNotificationSession	getAuditNotificationSessionForInquest(AuditReceiver auditReceiver, Id inquestId) Gets the OsidSession associated with the audit notification service for the given inquest.
AuditQuerySession	getAuditQuerySession() Gets the OsidSession associated with the audit query service.
AuditQuerySession	getAuditQuerySessionForInquest(Id inquestId) Gets the OsidSession associated with the audit query service for the given inquest.
AuditSearchSession	getAuditSearchSession() Gets the OsidSession associated with the audit search service.
AuditSearchSession	getAuditSearchSessionForInquest(Id inquestId) Gets the OsidSession associated with the audit search service for the given inquest.
AuditSmartInquestSession	getAuditSmartInquestSession(Id inquestId) Gets the OsidSession to manage audit smart inquests.
InquestAdminSession	getInquestAdminSession() Gets the OsidSession associated with the inquest administrative service.
InquestHierarchyDesignSession	getInquestHierarchyDesignSession() Gets the OsidSession associated with the inquest hierarchy design service.
InquestHierarchySession	getInquestHierarchySession() Gets the OsidSession associated with the inquest hierarchy service.
InquestLookupSession	getInquestLookupSession() Gets the OsidSession associated with the inquest lookup service.
InquestNotificationSession	getInquestNotificationSession(InquestReceiver inquestReceiver) Gets the OsidSession associated with the inquest notification service.
InquestQuerySession	getInquestQuerySession() Gets the OsidSession associated with the inquest query service.
InquestSearchSession	getInquestSearchSession() Gets the OsidSession associated with the inquest search service.
InquiryAdminSession	getInquiryAdminSession() Gets the OsidSession associated with the inquiry administration service.
InquiryAdminSession	getInquiryAdminSessionForInquest(Id inquestId) Gets the OsidSession associated with the inquiry administration service for the given inquest.
InquiryBatchManager	getInquiryBatchManager() Gets the InquiryBatchManager.
InquiryInquestAssignmentSession	getInquiryInquestAssignmentSession() Gets the OsidSession associated with assigning inquiries to inquests.
InquiryInquestSession	getInquiryInquestSession() Gets the OsidSession to lookup inquiry/inquest mappings.
InquiryLookupSession	getInquiryLookupSession() Gets the OsidSession associated with the inquiry lookup service.
InquiryLookupSession	getInquiryLookupSessionForInquest(Id inquestId) Gets the OsidSession associated with the inquiry lookup service for the given inquest.
InquiryNotificationSession	getInquiryNotificationSession(InquiryReceiver inquiryReceiver) Gets the OsidSession associated with the inquiry notification service.
InquiryNotificationSession	getInquiryNotificationSessionForInquest(InquiryReceiver inquiryReceiver, Id inquestId) Gets the OsidSession associated with the inquiry notification service for the given inquest.
InquiryQuerySession	getInquiryQuerySession() Gets the OsidSession associated with the inquiry query service.
InquiryQuerySession	getInquiryQuerySessionForInquest(Id inquestId) Gets the OsidSession associated with the inquiry query service for the given inquest.
InquiryRulesManager	getInquiryRulesManager() Gets the InquiryRulesManager.
InquirySearchSession	getInquirySearchSession() Gets the OsidSession associated with the inquiry search service.
InquirySearchSession	getInquirySearchSessionForInquest(Id inquestId) Gets the OsidSession associated with the inquiry search service for the given inquest.
InquirySmartInquestSession	getInquirySmartInquestSession(Id inquestId) Gets the OsidSession to manage inquiry smart inquests.
ResponseAdminSession	getResponseAdminSession() Gets the OsidSession associated with the response administration service.
ResponseAdminSession	getResponseAdminSessionForInput(Id inquestId) Gets the OsidSession associated with the response administration service for the given inquest.
ResponseInquestAssignmentSession	getResponseInquestAssignmentSession() Gets the OsidSession associated with assigning responses to inquests.
ResponseInquestSession	getResponseInquestSession() Gets the OsidSession to lookup response/inquest mappings.
ResponseLookupSession	getResponseLookupSession() Gets the OsidSession associated with the response lookup service.
ResponseLookupSession	getResponseLookupSessionForInquest(Id inquestId) Gets the OsidSession associated with the response lookup service for the given inquest.
ResponseNotificationSession	getResponseNotificationSession(ResponseReceiver responseReceiver) Gets the OsidSession associated with the response notification service.
ResponseNotificationSession	getResponseNotificationSessionForInquest(ResponseReceiver responseReceiver, Id inquestId) Gets the OsidSession associated with the response notification service for the given inquest.
ResponseQuerySession	getResponseQuerySession() Gets the OsidSession associated with the response query service.
ResponseQuerySession	getResponseQuerySessionForInquest(Id inquestId) Gets the OsidSession associated with the response query service for the given inquest.
ResponseSearchSession	getResponseSearchSession() Gets the OsidSession associated with the response search service.
ResponseSearchSession	getResponseSearchSessionForInquest(Id inquestId) Gets the OsidSession associated with the response search service for the given inquest.
ResponseSmartInquestSession	getResponseSmartInquestSession(Id inquestId) Gets the OsidSession to manage locatin smart inquests.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the acknowledgement service.

Returns:

an AcknowledgementSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgement() is false

Compliance:

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

getAcknowledgementSessionForInquest

AcknowledgementSession getAcknowledgementSessionForInquest(Id inquestId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

inquestId - the Id of the inquest

Returns:

an AcknowledgementSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgement() or supportsVisibleFederation() is false

Compliance:

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

getAcknowledgementNotificationSession

AcknowledgementNotificationSession getAcknowledgementNotificationSession(InquiryReceiver inquiryReceiver)
                                                                         throws OperationFailedException

Gets the OsidSession associated with the acknowledgement notification service for inquiries related to the authentciated agent.

Parameters:

inquiryReceiver - the notification callback

Returns:

an AcknowledgementNotificationSession

Throws:

NullArgumentException - inquiryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgementNotification() is false

Compliance:

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

getAcknowledgementNotificationSessionForInquest

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

Gets the OsidSession associated with the acknowledgement notification service for the given inquest for inquiries related to the authentciated agent.

Parameters:

inquiryReceiver - the notification callback

inquestId - the Id of the Inquest

Returns:

an AcknowledgementNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquiryReceiver or inquestId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgementNotification() or supportsVisibleFederation() is false

Compliance:

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

getInquiryLookupSession

InquiryLookupSession getInquiryLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the inquiry lookup service.

Returns:

an InquiryLookupSession

Throws:

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)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquiryLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the inquiry query service.

Returns:

an InquiryQuerySession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquiryQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the inquiry search service.

Returns:

an InquirySearchSession

Throws:

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)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquirySearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the inquiry administration service.

Returns:

an InquiryAdminSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquiryAdminSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the inquiry notification service.

Parameters:

inquiryReceiver - the notification callback

Returns:

an InquiryNotificationSession

Throws:

NullArgumentException - inquiryReceiver 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)
                                                                   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

Returns:

an InquiryNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquiryReceiver or inquestId 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()
                                               throws OperationFailedException

Gets the OsidSession to lookup inquiry/inquest mappings.

Returns:

an InquiryInquestSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryInquest() is false

Compliance:

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

getInquiryInquestAssignmentSession

InquiryInquestAssignmentSession getInquiryInquestAssignmentSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning inquiries to inquests.

Returns:

an InquiryInquestAssignmentSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession to manage inquiry smart inquests.

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquirySmartInquestSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the audit lookup service.

Returns:

an AuditLookupSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an AuditLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the audit query service.

Returns:

an AuditQuerySession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an AuditQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the audit search service.

Returns:

an AuditSearchSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an AuditSearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the audit administration service.

Returns:

an AuditAdminSession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an AuditAdminSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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)
                                                     throws OperationFailedException

Gets the OsidSession associated with the audit notification service.

Parameters:

auditReceiver - the notification callback

Returns:

an AuditNotificationSession

Throws:

NullArgumentException - auditReceiver 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)
                                                               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

Returns:

an AuditNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - auditReceiver or inquestId 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()
                                           throws OperationFailedException

Gets the OsidSession to lookup audit/inquest mappings.

Returns:

an AuditInquestSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditInquest() is false

Compliance:

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

getAuditInquestAssignmentSession

AuditInquestAssignmentSession getAuditInquestAssignmentSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning audits to inquests.

Returns:

an AuditInquestAssignmentSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession to manage audit smart inquests.

Parameters:

inquestId - the Id of the inquest

Returns:

an AuditSmartInquestSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the response lookup service.

Returns:

a ResponseLookupSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

inquestId - the Id of the inquest

Returns:

a ResponseLookupSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the response query service.

Returns:

a ResponseQuerySession

Throws:

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)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

a ResponseQuerySession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the response search service.

Returns:

a ResponseSearchSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

a ResponseSearchSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the response administration service.

Returns:

a ResponseAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseAdmin() is false

Compliance:

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

getResponseAdminSessionForInput

ResponseAdminSession getResponseAdminSessionForInput(Id inquestId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

inquestId - the Id of the Dostributor

Returns:

a ResponseAdminSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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)
                                                           throws OperationFailedException

Gets the OsidSession associated with the response notification service.

Parameters:

responseReceiver - the notification callback

Returns:

a ResponseNotificationSession

Throws:

NullArgumentException - responseReceiver 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)
                                                                     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

Returns:

a ResponseNotificationSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - responseReceiver or inquestId 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()
                                                 throws OperationFailedException

Gets the OsidSession to lookup response/inquest mappings.

Returns:

a ResponseInquestSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseInquest() is false

Compliance:

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

getResponseInquestAssignmentSession

ResponseInquestAssignmentSession getResponseInquestAssignmentSession()
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning responses to inquests.

Returns:

a ResponseInquestAssignmentSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession to manage locatin smart inquests.

Parameters:

inquestId - the Id of the Inquest

Returns:

a ResponseSmartInquestSession

Throws:

NotFoundException - no inquest found by the given Id

NullArgumentException - inquestId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the inquest lookup service.

Returns:

an InquestLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestLookup() is false

Compliance:

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

getInquestQuerySession

InquestQuerySession getInquestQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the inquest query service.

Returns:

an InquestQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestQuery() is false

Compliance:

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

getInquestSearchSession

InquestSearchSession getInquestSearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the inquest search service.

Returns:

an InquestSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestSearch() is false

Compliance:

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

getInquestAdminSession

InquestAdminSession getInquestAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the inquest administrative service.

Returns:

an InquestAdminSession

Throws:

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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the inquest notification service.

Parameters:

inquestReceiver - the notification callback

Returns:

an InquestNotificationSession

Throws:

NullArgumentException - inquestReceiver 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()
                                                   throws OperationFailedException

Gets the OsidSession associated with the inquest hierarchy service.

Returns:

an InquestHierarchySession for inquests

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestHierarchy() is false

Compliance:

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

getInquestHierarchyDesignSession

InquestHierarchyDesignSession getInquestHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the inquest hierarchy design service.

Returns:

an HierarchyDesignSession for inquests

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestHierarchyDesign() is false

Compliance:

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

getInquiryBatchManager

InquiryBatchManager getInquiryBatchManager()
                                           throws OperationFailedException

Gets the InquiryBatchManager.

Returns:

an InquiryBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryBatch() is false

Compliance:

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

getInquiryRulesManager

InquiryRulesManager getInquiryRulesManager()
                                           throws OperationFailedException

Gets the InquiryRulesManager.

Returns:

an InquiryRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryRules() is false

Compliance:

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