OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.AntimatroidSearch
Implementsosid.OsidSearch
Description

The search interface for governing antimatroid searches.

MethodsearchAmongAntimatroids
Description

Execute this search among the given list of antimatroids.

Parametersosid.id.IdListantimatroidIdslist of antimatroids
ErrorsNULL_ARGUMENT antimatroidIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAntimatroidResults
Description

Specify an ordering to the search results.

Parametersosid.sequencing.AntimatroidSearchOrderantimatroidSearchOrderantimatroid search order
ErrorsNULL_ARGUMENT antimatroidSearchOrder is null
UNSUPPORTED antimatroidSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidSearchRecord
Description

Gets the antimatroid search record corresponding to the given antimatroid search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeantimatroidSearchRecordTypean antimatroid search record type
Returnosid.sequencing.records.AntimatroidSearchRecordthe antimatroid search record
ErrorsNULL_ARGUMENT antimatroidSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(antimatroidSearchRecordType) is false
CompliancemandatoryThis method must be implemented.