OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching chains. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchFifo
Description

Matches fifo chains.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearFifoTerms
Description

Clears the fifo query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchElement
Description

Sets the element Id for this query.

Parametersosid.id.IdelementIdthe element Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT elementId is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyElement
Description

Matches chains with any element.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearElementTerms
Description

Clears the element query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAntimatroidId
Description

Sets the action group Id for this query to match sequencinglers assigned to action groups.

Parametersosid.id.IdactionGroupIdthe action group Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT actionGroupId is null
CompliancemandatoryThis method must be implemented.
MethodclearAntimatroidIdTerms
Description

Clears the antimatroid Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAntimatroidQuery
Description

Tests if an AntimatroidQuery is available.

Returnboolean true if an antimatroid query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidQuery
Description

Gets the query for an antimatroid. Multiple retrievals produce a nested OR term.

Returnosid.sequencing.AntimatroidQuerythe antimatroid query
ErrorsUNIMPLEMENTED supportsAntimatroidQuery() is false
ComplianceoptionalThis method must be implemented if supportsAntimatroidQuery() is true.
MethodclearAntimatroidTerms
Description

Clears the antimatroid query terms.

CompliancemandatoryThis method must be implemented.
MethodgetChainQueryRecord
Description

Gets the query record corresponding to the given Chain record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypechainRecordTypea chain record type
Returnosid.sequencing.records.ChainQueryRecordthe chain query record
ErrorsNULL_ARGUMENT chainRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(chainRecordType) is false
CompliancemandatoryThis method must be implemented.