org.osid.inquiry

Interface InquiryProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

InquiryManager, InquiryProxyManager

public interface InquiryProfile
extends OsidProfile

The inquiry profile describes the interoperability among inquiry services.

Method Summary

Methods

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any action group federation is exposed. Federation is exposed when a specific action group may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of action groups appears as a single action group.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcknowledgement

boolean supportsAcknowledgement()

Tests if an acknowledgement service is supported for the current agent.

Returns:

true if acknowledgement is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcknowledgementNotification

boolean supportsAcknowledgementNotification()

Tests if an acknowledgement notification service is supported for the current agent.

Returns:

true if an acknowledgement notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryLookup

boolean supportsInquiryLookup()

Tests if looking up inquiries is supported.

Returns:

true if inquiry lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryQuery

boolean supportsInquiryQuery()

Tests if querying inquiries is supported.

Returns:

true if inquiry query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquirySearch

boolean supportsInquirySearch()

Tests if searching inquiries is supported.

Returns:

true if inquiry search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryAdmin

boolean supportsInquiryAdmin()

Tests if an inquiry administrative service is supported.

Returns:

true if inquiry administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryNotification

boolean supportsInquiryNotification()

Tests if an inquiry notification service is supported.

Returns:

true if inquiry notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryInquest

boolean supportsInquiryInquest()

Tests if an inquiry inquest lookup service is supported.

Returns:

true if an inquiry inquest lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryInquestAssignment

boolean supportsInquiryInquestAssignment()

Tests if an inquiry inquest assignment service is supported.

Returns:

true if an inquiry to inquest assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquirySmartInquest

boolean supportsInquirySmartInquest()

Tests if an inquiry smart inquest service is supported.

Returns:

true if a smart inquest service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditLookup

boolean supportsAuditLookup()

Tests if looking up audits is supported.

Returns:

true if audit lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditQuery

boolean supportsAuditQuery()

Tests if querying audits is supported.

Returns:

true if audit query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditSearch

boolean supportsAuditSearch()

Tests if searching audits is supported.

Returns:

true if audit search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditAdmin

boolean supportsAuditAdmin()

Tests if audit administrative service is supported.

Returns:

true if audit administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditNotification

boolean supportsAuditNotification()

Tests if an audit notification service is supported.

Returns:

true if audit notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditInquest

boolean supportsAuditInquest()

Tests if an audit inquest lookup service is supported.

Returns:

true if an audit inquest lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditInquestAssignment

boolean supportsAuditInquestAssignment()

Tests if an audit inquest service is supported.

Returns:

true if audit to inquest assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuditSmartInquest

boolean supportsAuditSmartInquest()

Tests if an audit smart inquest lookup service is supported.

Returns:

true if an audit smart inquest service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseLookup

boolean supportsResponseLookup()

Tests if looking up responses is supported.

Returns:

true if response lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseQuery

boolean supportsResponseQuery()

Tests if querying responses is supported.

Returns:

true if response query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseSearch

boolean supportsResponseSearch()

Tests if searching responses is supported.

Returns:

true if response search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseAdmin

boolean supportsResponseAdmin()

Tests if response administrative service is supported.

Returns:

true if response administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseNotification

boolean supportsResponseNotification()

Tests if a response notification service is supported.

Returns:

true if response notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseInquest

boolean supportsResponseInquest()

Tests if a response inquest lookup service is supported.

Returns:

true if a response inquest lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseInquestAssignment

boolean supportsResponseInquestAssignment()

Tests if a response inquest assignment service is supported.

Returns:

true if a response to inquest assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResponseSmartInquest

boolean supportsResponseSmartInquest()

Tests if a response smart inquest service is supported.

Returns:

true if a response smart inquest service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestLookup

boolean supportsInquestLookup()

Tests if looking up inquests is supported.

Returns:

true if inquest lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestQuery

boolean supportsInquestQuery()

Tests if querying inquests is supported.

Returns:

true if an inquest query service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestSearch

boolean supportsInquestSearch()

Tests if searching inquests is supported.

Returns:

true if inquest search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestAdmin

boolean supportsInquestAdmin()

Tests if inquest administrative service is supported.

Returns:

true if inquest administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestNotification

boolean supportsInquestNotification()

Tests if an inquest notification service is supported.

Returns:

true if inquest notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquestHierarchy

boolean supportsInquestHierarchy()

Tests for the availability of an inquest hierarchy traversal service.

Returns:

true if inquest hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsInquestHierarchyDesign

boolean supportsInquestHierarchyDesign()

Tests for the availability of an inquest hierarchy design service.

Returns:

true if inquest hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryBatch

boolean supportsInquiryBatch()

Tests for the availability of a inquiry batch service.

Returns:

true if inquiry batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInquiryRules

boolean supportsInquiryRules()

Tests for the availability of a inquiry rules service.

Returns:

true if inquiry rules service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquiryRecordTypes

TypeList getInquiryRecordTypes()

Gets the supported Inquiry record types.

Returns:

a list containing the supported Inquiry record types

Compliance:

mandatory - This method must be implemented.

supportsInquiryRecordType

boolean supportsInquiryRecordType(Type inquiryRecordType)

Tests if the given Inquiry record type is supported.

Parameters:

inquiryRecordType - a Type indicating a Inquiry record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - inquiryRecordType is null

Compliance:

mandatory - This method must be implemented.

getInquirySearchRecordTypes

TypeList getInquirySearchRecordTypes()

Gets the supported Inquiry search types.

Returns:

a list containing the supported Inquiry search types

Compliance:

mandatory - This method must be implemented.

supportsInquirySearchRecordType

boolean supportsInquirySearchRecordType(Type inquirySearchRecordType)

Tests if the given Inquiry search type is supported.

Parameters:

inquirySearchRecordType - a Type indicating a Inquiry search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - inquirySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuditRecordTypes

TypeList getAuditRecordTypes()

Gets the supported Audit record types.

Returns:

a list containing the supported Audit record types

Compliance:

mandatory - This method must be implemented.

supportsAuditRecordType

boolean supportsAuditRecordType(Type auditRecordType)

Tests if the given Audit record type is supported.

Parameters:

auditRecordType - a Type indicating a Audit record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - auditRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuditSearchRecordTypes

TypeList getAuditSearchRecordTypes()

Gets the supported Audit search record types.

Returns:

a list containing the supported Audit search record types

Compliance:

mandatory - This method must be implemented.

supportsAuditSearchRecordType

boolean supportsAuditSearchRecordType(Type auditSearchRecordType)

Tests if the given Audit search record type is supported.

Parameters:

auditSearchRecordType - a Type indicating a Audit search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - auditSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getResponseRecordTypes

TypeList getResponseRecordTypes()

Gets the supported Response record types.

Returns:

a list containing the supported Response record types

Compliance:

mandatory - This method must be implemented.

supportsResponseRecordType

boolean supportsResponseRecordType(Type responseRecordType)

Tests if the given Response record type is supported.

Parameters:

responseRecordType - a Type indicating a Response record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - responseRecordType is null

Compliance:

mandatory - This method must be implemented.

getResponseSearchRecordTypes

TypeList getResponseSearchRecordTypes()

Gets the supported Response search types.

Returns:

a list containing the supported Response search types

Compliance:

mandatory - This method must be implemented.

supportsResponseSearchRecordType

boolean supportsResponseSearchRecordType(Type responseSearchRecordType)

Tests if the given Response search type is supported.

Parameters:

responseSearchRecordType - a Type indicating a Response search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - responseSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getInquestRecordTypes

TypeList getInquestRecordTypes()

Gets the supported Inquest record types.

Returns:

a list containing the supported Inquest types

Compliance:

mandatory - This method must be implemented.

supportsInquestRecordType

boolean supportsInquestRecordType(Type inquestRecordType)

Tests if the given Inquest record type is supported.

Parameters:

inquestRecordType - a Type indicating a Inquest record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - inquestRecordType is null

Compliance:

mandatory - This method must be implemented.

getInquestSearchRecordTypes

TypeList getInquestSearchRecordTypes()

Gets the supported Inquest search record types.

Returns:

a list containing the supported Inquest search record types

Compliance:

mandatory - This method must be implemented.

supportsInquestSearchRecordType

boolean supportsInquestSearchRecordType(Type inquestSearchRecordType)

Tests if the given Inquest search record type is supported.

Parameters:

inquestSearchRecordType - a Type indicating a Inquest search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - inquestSearchRecordType is null

Compliance:

mandatory - This method must be implemented.