OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.AntimatroidSearchSession
Implementsosid.sequencing.AntimatroidQuerySession
Description

This session provides methods for searching among Antimatroid objects. The search query is constructed using the AntimatroidQuery.

getAntimatroidsByQuery() is the basic search method and returns a list of Antimatroids. A more advanced search may be performed with getAntimatroidsBySearch(). It accepts an AntimatroidSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAntimatroidsBySearch() returns an AntimatroidSearchResults that can be used to access the resulting AntimatroidList or be used to perform a search within the result set through AntimatroidSearch.

Antimatroids may have a query record indicated by their respective record types. The query record is accessed via the AntimatroidQuery.

MethodgetAntimatroidSearch
Description

Gets an antimatroid search.

Returnosid.sequencing.AntimatroidSearchthe antimatroid search
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidSearchOrder
Description

Gets an antimatroid search order. The AntimatroidSearchOrder is supplied to an AntimatroidSearch to specify the ordering of results.

Returnosid.sequencing.AntimatroidSearchOrderthe antimatroid search order
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.sequencing.AntimatroidQueryantimatroidQuerythe antimatroid query
osid.sequencing.AntimatroidSearchantimatroidSearchthe antimatroid search
Returnosid.sequencing.AntimatroidSearchResultsthe antimatroid search results
ErrorsNULL_ARGUMENT antimatroidQuery or antimatroidSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED antimatroidQuery or antimatroidSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidQueryFromInspector
Description

Gets an antimatroid query from an inspector. The inspector is available from an AntimatroidSearchResults.

Parametersosid.sequencing.AntimatroidQueryInspectorantimatroidQueryInspectoran antimatroid query inspector
Returnosid.sequencing.AntimatroidQuerythe antimatroid query
ErrorsNULL_ARGUMENT antimatroidQueryInspector is null
UNSUPPORTED antimatroidQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.