Interface InquiryManager

All Superinterfaces:

AutoCloseable, Closeable, InquiryProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getAuditRecordTypes()	Gets the supported Audit record types.
TypeList	getAuditSearchRecordTypes()	Gets the supported Audit search record types.
TypeList	getInquestRecordTypes()	Gets the supported Inquest record types.
TypeList	getInquestSearchRecordTypes()	Gets the supported Inquest search record types.
TypeList	getInquiryRecordTypes()	Gets the supported Inquiry record types.
TypeList	getInquirySearchRecordTypes()	Gets the supported Inquiry search types.
TypeList	getResponseRecordTypes()	Gets the supported Response record types.
TypeList	getResponseSearchRecordTypes()	Gets the supported Response search types.
boolean	supportsAcknowledgement()	Tests if an acknowledgement service is supported for the current agent.
boolean	supportsAcknowledgementNotification()	Tests if an acknowledgement notification service is supported for the current agent.
boolean	supportsAuditAdmin()	Tests if audit administrative service is supported.
boolean	supportsAuditInquest()	Tests if an audit inquest lookup service is supported.
boolean	supportsAuditInquestAssignment()	Tests if an audit inquest service is supported.
boolean	supportsAuditLookup()	Tests if looking up audits is supported.
boolean	supportsAuditNotification()	Tests if an audit notification service is supported.
boolean	supportsAuditQuery()	Tests if querying audits is supported.
boolean	supportsAuditRecordType(Type auditRecordType)	Tests if the given Audit record type is supported.
boolean	supportsAuditSearch()	Tests if searching audits is supported.
boolean	supportsAuditSearchRecordType(Type auditSearchRecordType)	Tests if the given Audit search record type is supported.
boolean	supportsAuditSmartInquest()	Tests if an audit smart inquest lookup service is supported.
boolean	supportsInquestAdmin()	Tests if inquest administrative service is supported.
boolean	supportsInquestHierarchy()	Tests for the availability of an inquest hierarchy traversal service.
boolean	supportsInquestHierarchyDesign()	Tests for the availability of an inquest hierarchy design service.
boolean	supportsInquestLookup()	Tests if looking up inquests is supported.
boolean	supportsInquestNotification()	Tests if an inquest notification service is supported.
boolean	supportsInquestQuery()	Tests if querying inquests is supported.
boolean	supportsInquestRecordType(Type inquestRecordType)	Tests if the given Inquest record type is supported.
boolean	supportsInquestSearch()	Tests if searching inquests is supported.
boolean	supportsInquestSearchRecordType(Type inquestSearchRecordType)	Tests if the given Inquest search record type is supported.
boolean	supportsInquiryAdmin()	Tests if an inquiry administrative service is supported.
boolean	supportsInquiryBatch()	Tests for the availability of an inquiry batch service.
boolean	supportsInquiryInquest()	Tests if an inquiry inquest lookup service is supported.
boolean	supportsInquiryInquestAssignment()	Tests if an inquiry inquest assignment service is supported.
boolean	supportsInquiryLookup()	Tests if looking up inquiries is supported.
boolean	supportsInquiryNotification()	Tests if an inquiry notification service is supported.
boolean	supportsInquiryQuery()	Tests if querying inquiries is supported.
boolean	supportsInquiryRecordType(Type inquiryRecordType)	Tests if the given Inquiry record type is supported.
boolean	supportsInquiryRules()	Tests for the availability of an inquiry rules service.
boolean	supportsInquirySearch()	Tests if searching inquiries is supported.
boolean	supportsInquirySearchRecordType(Type inquirySearchRecordType)	Tests if the given Inquiry search type is supported.
boolean	supportsInquirySmartInquest()	Tests if an inquiry smart inquest service is supported.
boolean	supportsResponseAdmin()	Tests if response administrative service is supported.
boolean	supportsResponseInquest()	Tests if a response inquest lookup service is supported.
boolean	supportsResponseInquestAssignment()	Tests if a response inquest assignment service is supported.
boolean	supportsResponseLookup()	Tests if looking up responses is supported.
boolean	supportsResponseNotification()	Tests if a response notification service is supported.
boolean	supportsResponseQuery()	Tests if querying responses is supported.
boolean	supportsResponseRecordType(Type responseRecordType)	Tests if the given Response record type is supported.
boolean	supportsResponseSearch()	Tests if searching responses is supported.
boolean	supportsResponseSearchRecordType(Type responseSearchRecordType)	Tests if the given Response search type is supported.
boolean	supportsResponseSmartInquest()	Tests if a response smart inquest service is supported.
boolean	supportsVisibleFederation()	Tests if any action group federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsAcknowledgement()} is {@code 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 {@code supportsAcknowledgement()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAcknowledgementNotification()} is {@code 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 {@code supportsAcknowledgementNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquiryLookup()} is {@code 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 {@code supportsInquiryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquiryQuery()} is {@code 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 {@code supportsInquiryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquirySearch()} is {@code 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 {@code supportsInquirySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquiryAdmin()} is {@code 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 {@code supportsInquiryAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquiryNotification()} is {@code 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 {@code supportsInquiryNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquiryInquest()} is {@code 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 {@code supportsInquiryInquestAssignment()} is {@code 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 {@code supportsInquirySmartInquest()} is {@code 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 {@code supportsAuditLookup()} is {@code 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 {@code supportsAuditLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditQuery()} is {@code 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 {@code supportsAuditQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditSearch()} is {@code 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 {@code supportsAuditSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditAdmin()} is {@code 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 {@code supportsAuditAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditNotification()} is {@code 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 {@code supportsAuditNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditInquest()} is {@code 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 {@code supportsAuditInquestAssignment()} is {@code 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 {@code supportsAuditSmartInquest()} is {@code 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 {@code supportsResponseLookup()} is {@code 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 {@code supportsResponseLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseQuery()} is {@code 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 {@code supportsResponseQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseSearch()} is {@code 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 {@code supportsResponseSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseAdmin()} is {@code 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 {@code supportsResponseAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseNotification()} is {@code 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 {@code supportsResponseNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseInquest()} is {@code 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 {@code supportsResponseInquestAssignment()} is {@code 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 {@code supportsResponseSmartInquest()} is {@code 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 {@code supportsInquestLookup()} is {@code 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 {@code supportsInquestQuery()} is {@code 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 {@code supportsInquestSearch()} is {@code 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 {@code supportsInquestAdmin()} is {@code 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 {@code supportsInquestNotification()} is {@code 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 {@code supportsInquestHierarchy()} is {@code 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 {@code supportsInquestHierarchyDesign()} is {@code 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 {@code supportsInquiryBatch()} is {@code 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 {@code supportsInquiryRules()} is {@code true} .