OSID Logo
OSID Specifications
sequencing package
Version 3.1.0
Interfaceosid.sequencing.AntimatroidSearchSession
Implementsosid.sequencing.AntimatroidQuerySession
Used Byosid.sequencing.SequencingManager
osid.sequencing.SequencingProxyManager
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.AntimatroidSearch the antimatroid search
Compliancemandatory This 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.AntimatroidSearchOrder the antimatroid search order
Compliancemandatory This method must be implemented.
MethodgetAntimatroidsBySearch
Description

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

Parametersosid.sequencing.AntimatroidQueryantimatroidQuery the antimatroid query
osid.sequencing.AntimatroidSearchantimatroidSearch the antimatroid search
Returnosid.sequencing.AntimatroidSearchResults the antimatroid search results
ErrorsNULL_ARGUMENT antimatroidQuery or antimatroidSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED antimatroidQuery or antimatroidSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAntimatroidQueryFromInspector
Description

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

Parametersosid.sequencing.AntimatroidQueryInspectorantimatroidQueryInspector an antimatroid query inspector
Returnosid.sequencing.AntimatroidQuery the antimatroid query
ErrorsNULL_ARGUMENT antimatroidQueryInspector is null
UNSUPPORTED antimatroidQueryInspector is not of this service
Compliancemandatory This method must be implemented.