OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBureau
Description

Orders the results by resource.

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

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBureauSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsResourceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchOrderRecord
Description

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

Parametersosid.type.TypeissueRecordTypean issue record type
Returnosid.hold.records.IssueSearchOrderRecordthe issue search order record
ErrorsNULL_ARGUMENT issueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(issueRecordType) is false
CompliancemandatoryThis method must be implemented.