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

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

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

MethodcanSearchAntimatroids
Description

Tests if this user can perform Antimatroid searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidQuery
Description

Gets an antimatroid query.

Returnosid.sequencing.AntimatroidQuerythe antimatroid query
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidsByQuery
Description

Gets a list of Antimatroids matching the given antimatroid query.

Parametersosid.sequencing.AntimatroidQueryantimatroidQuerythe antimatroid query
Returnosid.sequencing.AntimatroidListthe returned AntimatroidList
ErrorsNULL_ARGUMENT antimatroidQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED antimatroidQuery is not of this service
CompliancemandatoryThis method must be implemented.