OSID - osid.inquiry.InquiryProfile Service Interface Definition

Interface	osid.inquiry.InquiryProfile
Implements	`osid.OsidProfile`
Description	The inquiry profile describes the interoperability among inquiry services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcknowledgement
Description	Tests if an acknowledgement service is supported for the current agent.
Return	`boolean`		`true` if acknowledgement is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcknowledgementNotification
Description	Tests if an acknowledgement notification service is supported for the current agent.
Return	`boolean`		`true` if an acknowledgement notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryLookup
Description	Tests if looking up inquiries is supported.
Return	`boolean`		`true` if inquiry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryQuery
Description	Tests if querying inquiries is supported.
Return	`boolean`		`true` if inquiry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquirySearch
Description	Tests if searching inquiries is supported.
Return	`boolean`		`true` if inquiry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryAdmin
Description	Tests if an inquiry administrative service is supported.
Return	`boolean`		`true` if inquiry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryNotification
Description	Tests if an inquiry notification service is supported.
Return	`boolean`		`true` if inquiry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryInquest
Description	Tests if an inquiry inquest lookup service is supported.
Return	`boolean`		`true` if an inquiry inquest lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryInquestAssignment
Description	Tests if an inquiry inquest assignment service is supported.
Return	`boolean`		`true` if an inquiry to inquest assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquirySmartInquest
Description	Tests if an inquiry smart inquest service is supported.
Return	`boolean`		`true` if a smart inquest service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditLookup
Description	Tests if looking up audits is supported.
Return	`boolean`		`true` if audit lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditQuery
Description	Tests if querying audits is supported.
Return	`boolean`		`true` if audit query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditSearch
Description	Tests if searching audits is supported.
Return	`boolean`		`true` if audit search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditAdmin
Description	Tests if audit administrative service is supported.
Return	`boolean`		`true` if audit administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditNotification
Description	Tests if an audit notification service is supported.
Return	`boolean`		`true` if audit notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditInquest
Description	Tests if an audit inquest lookup service is supported.
Return	`boolean`		`true` if an audit inquest lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditInquestAssignment
Description	Tests if an audit inquest service is supported.
Return	`boolean`		`true` if audit to inquest assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditSmartInquest
Description	Tests if an audit smart inquest lookup service is supported.
Return	`boolean`		`true` if an audit smart inquest service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseLookup
Description	Tests if looking up responses is supported.
Return	`boolean`		`true` if response lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseQuery
Description	Tests if querying responses is supported.
Return	`boolean`		`true` if response query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseSearch
Description	Tests if searching responses is supported.
Return	`boolean`		`true` if response search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseAdmin
Description	Tests if response administrative service is supported.
Return	`boolean`		`true` if response administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseNotification
Description	Tests if a response notification service is supported.
Return	`boolean`		`true` if response notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseInquest
Description	Tests if a response inquest lookup service is supported.
Return	`boolean`		`true` if a response inquest lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseInquestAssignment
Description	Tests if a response inquest assignment service is supported.
Return	`boolean`		`true` if a response to inquest assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseSmartInquest
Description	Tests if a response smart inquest service is supported.
Return	`boolean`		`true` if a response smart inquest service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestLookup
Description	Tests if looking up inquests is supported.
Return	`boolean`		`true` if inquest lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestQuery
Description	Tests if querying inquests is supported.
Return	`boolean`		`true` if an inquest query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestSearch
Description	Tests if searching inquests is supported.
Return	`boolean`		`true` if inquest search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestAdmin
Description	Tests if inquest administrative service is supported.
Return	`boolean`		`true` if inquest administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestNotification
Description	Tests if an inquest notification service is supported.
Return	`boolean`		`true` if inquest notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestHierarchy
Description	Tests for the availability of an inquest hierarchy traversal service.
Return	`boolean`		`true` if inquest hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsInquestHierarchyDesign
Description	Tests for the availability of an inquest hierarchy design service.
Return	`boolean`		`true` if inquest hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryBatch
Description	Tests for the availability of a inquiry batch service.
Return	`boolean`		`true` if inquiry batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryRules
Description	Tests for the availability of a inquiry rules service.
Return	`boolean`		`true` if inquiry rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryRecordTypes
Description	Gets the supported `Inquiry` record types.
Return	`osid.type.TypeList`		a list containing the supported `Inquiry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryRecordType
Description	Tests if the given `Inquiry` record type is supported.
Parameters	`osid.type.Type`	`inquiryRecordType`	a `Type` indicating a `Inquiry` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquiryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquirySearchRecordTypes
Description	Gets the supported `Inquiry` search types.
Return	`osid.type.TypeList`		a list containing the supported `Inquiry` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquirySearchRecordType
Description	Tests if the given `Inquiry` search type is supported.
Parameters	`osid.type.Type`	`inquirySearchRecordType`	a `Type` indicating a `Inquiry` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquirySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditRecordTypes
Description	Gets the supported `Audit` record types.
Return	`osid.type.TypeList`		a list containing the supported `Audit` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditRecordType
Description	Tests if the given `Audit` record type is supported.
Parameters	`osid.type.Type`	`auditRecordType`	a `Type` indicating a `Audit` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditSearchRecordTypes
Description	Gets the supported `Audit` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Audit` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditSearchRecordType
Description	Tests if the given `Audit` search record type is supported.
Parameters	`osid.type.Type`	`auditSearchRecordType`	a `Type` indicating a `Audit` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResponseRecordTypes
Description	Gets the supported `Response` record types.
Return	`osid.type.TypeList`		a list containing the supported `Response` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseRecordType
Description	Tests if the given `Response` record type is supported.
Parameters	`osid.type.Type`	`responseRecordType`	a `Type` indicating a `Response` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`responseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResponseSearchRecordTypes
Description	Gets the supported `Response` search types.
Return	`osid.type.TypeList`		a list containing the supported `Response` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseSearchRecordType
Description	Tests if the given `Response` search type is supported.
Parameters	`osid.type.Type`	`responseSearchRecordType`	a `Type` indicating a `Response` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`responseSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquestRecordTypes
Description	Gets the supported `Inquest` record types.
Return	`osid.type.TypeList`		a list containing the supported `Inquest` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestRecordType
Description	Tests if the given `Inquest` record type is supported.
Parameters	`osid.type.Type`	`inquestRecordType`	a `Type` indicating a `Inquest` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquestRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInquestSearchRecordTypes
Description	Gets the supported `Inquest` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Inquest` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestSearchRecordType
Description	Tests if the given `Inquest` search record type is supported.
Parameters	`osid.type.Type`	`inquestSearchRecordType`	a `Type` indicating a `Inquest` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inquestSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.