OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.AntimatroidQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchChainId
Description

Sets the chain Id for this query.

Parametersosid.id.IdchainIdthe chain Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT chainId is null
CompliancemandatoryThis method must be implemented.
MethodclearChainIdTerms
Description

Clears the chain Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInputQuery
Description

Tests if a ChainQuery is available.

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

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

Returnosid.sequencing.ChainQuerythe chain query
ErrorsUNIMPLEMENTED supportsChainQuery() is false
ComplianceoptionalThis method must be implemented if supportsChainQuery() is true.
MethodmatchAnyChain
Description

Matches action groups with any chain.

Parametersbooleanmatch true to match antimatroids with any chain, false to match antimatroids with no chains
CompliancemandatoryThis method must be implemented.
MethodclearChainTerms
Description

Clears the chain query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorAntimatroidId
Description

Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as an ancestor.

Parametersosid.id.IdantimatroidIdan antimatroid Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT antimatroidId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAntimatroidIdTerms
Description

Clears the ancestor antimatroid Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorAntimatroidQuery
Description

Tests if an AntimatroidQuery is available.

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

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

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

Matches antimatroids with any ancestor.

Parametersbooleanmatch true to match antimatroids with any ancestor, false to match root antimatroids
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAntimatroidTerms
Description

Clears the ancestor antimatroid query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantAntimatroidId
Description

Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as a descendant.

Parametersosid.id.IdantimatroidIdan antimatroid Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT antimatroidId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAntimatroidIdTerms
Description

Clears the descendant antimatroid Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantAntimatroidQuery
Description

Tests if an AntimatroidQuery is available.

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

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

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

Matches antimatroids with any descendant.

Parametersbooleanmatch true to match antimatroids with any descendant, false to match leaf antimatroids
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAntimatroidTerms
Description

Clears the descendant antimatroid query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidQueryRecord
Description

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

Parametersosid.type.TypeantimatroidRecordTypean antimatroid record type
Returnosid.sequencing.records.AntimatroidQueryRecordthe antimatroid query record
ErrorsNULL_ARGUMENT antimatroidRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(antimatroidRecordType) is false
CompliancemandatoryThis method must be implemented.