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

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

This session defines views that offer differing behaviors for searching.

  • federated antimatroid view: searches include chains in antimatroids of which this antimatroid is an ancestor in the antimatroid hierarchy
  • isolated antimatroid view: searches are restricted to chains in this antimatroid

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

MethodgetAntimatroidId
Description

Gets the Antimatroid Id associated with this session.

Returnosid.id.Idthe Antimatroid Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroid
Description

Gets the Antimatroid associated with this session.

Returnosid.sequencing.Antimatroidthe antimatroid
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchChains
Description

Tests if this user can perform Chain lookups. 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.
MethoduseFederatedAntimatroidView
Description

Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAntimatroidView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this antimatroid only.

CompliancemandatoryThis method is must be implemented.
MethodgetChainQuery
Description

Gets a chain query.

Returnosid.sequencing.ChainQuerythe chain query
CompliancemandatoryThis method must be implemented.
MethodgetChainsByQuery
Description

Gets a list of Chains matching the given chain query.

Parametersosid.sequencing.ChainQuerychainQuerythe chain query
Returnosid.sequencing.ChainListthe returned ChainList
ErrorsNULL_ARGUMENT chainQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED chainQuery is not of this service
CompliancemandatoryThis method must be implemented.