OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquirySearchOrder
Implementsosid.OsidRuleSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAudit
Description

Orders the results by the audit.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsAuditSearchOrder
Description

Tests if an audit search order is available.

Returnboolean true if an audit search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuditSearchOrder
Description

Gets the audit search order.

Returnosid.inquiry.AuditSearchOrderthe audit search order
ErrorsILLEGAL_STATE supportsAuditSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByQuestion
Description

Orders the results by the question.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByRequired
Description

Orders the results by the required flag.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByAffirmationRequired
Description

Orders the results by the affirmation required flag.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByNeedsOneResponse
Description

Orders the results by the needs one response flag.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetInquirySearchOrderRecord
Description

Gets the inquiry search order record corresponding to the given inquiry record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeinquiryRecordTypean inquiry record type
Returnosid.inquiry.records.InquirySearchOrderRecordthe inquiry search order record
ErrorsNULL_ARGUMENT inquiryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquiryRecordType) is false
CompliancemandatoryThis method must be implemented.