Interface | osid.sequencing.AntimatroidQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching antimatroids. Each method
match specifies an | ||
Method | matchChainId | ||
Description |
Sets the chain | ||
Parameters | osid.id.Id | chainId | the chain Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | chainId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearChainIdTerms | ||
Description |
Clears the chain | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an input query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainQuery | ||
Description |
Gets the query for a chain. Multiple retrievals produce
a nested | ||
Return | osid.sequencing.ChainQuery | the chain query | |
Errors | UNIMPLEMENTED | supportsChainQuery() is false | |
Compliance | optional | This method must be implemented if supportsChainQuery() is
true. | |
Method | matchAnyChain | ||
Description |
Matches action groups with any chain. | ||
Parameters | boolean | match | true to match antimatroids with any chain, false
to match antimatroids with no chains |
Compliance | mandatory | This method must be implemented. | |
Method | clearChainTerms | ||
Description |
Clears the chain query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorAntimatroidId | ||
Description |
Sets the antimatroid | ||
Parameters | osid.id.Id | antimatroidId | an antimatroid Id |
boolean | match | true for a positive match, false for negative
match | |
Errors | NULL_ARGUMENT | antimatroidId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAntimatroidIdTerms | ||
Description |
Clears the ancestor antimatroid | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorAntimatroidQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an antimatroid query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAntimatroidQuery | ||
Description |
Gets the query for an antimatroid. Multiple retrievals
produce a nested | ||
Return | osid.sequencing.AntimatroidQuery | the antimatroid query | |
Errors | UNIMPLEMENTED | supportsAncestorAntimatroidQuery() is false | |
Compliance | optional | This method must be implemented if
supportsAncestorAntimatroidQuery() is true. | |
Method | matchAnyAncestorAntimatroid | ||
Description |
Matches antimatroids with any ancestor. | ||
Parameters | boolean | match | true to match antimatroids with any ancestor, false
to match root antimatroids |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAntimatroidTerms | ||
Description |
Clears the ancestor antimatroid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantAntimatroidId | ||
Description |
Sets the antimatroid | ||
Parameters | osid.id.Id | antimatroidId | an antimatroid Id |
boolean | match | true for a positive match, false for negative
match | |
Errors | NULL_ARGUMENT | antimatroidId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAntimatroidIdTerms | ||
Description |
Clears the descendant antimatroid | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantAntimatroidQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an antimatroid query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAntimatroidQuery | ||
Description |
Gets the query for an antimatroid/ Multiple retrievals
produce a nested | ||
Return | osid.sequencing.AntimatroidQuery | the antimatroid query | |
Errors | UNIMPLEMENTED | supportsDescendantAntimatroidQuery() is false | |
Compliance | optional | This method must be implemented if
supportsDescendantAntimatroidQuery() is true. | |
Method | matchAnyDescendantAntimatroid | ||
Description |
Matches antimatroids with any descendant. | ||
Parameters | boolean | match | true to match antimatroids with any descendant, false
to match leaf antimatroids |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAntimatroidTerms | ||
Description |
Clears the descendant antimatroid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroidQueryRecord | ||
Description |
Gets the antimatroid query record corresponding to the
given | ||
Parameters | osid.type.Type | antimatroidRecordType | an antimatroid record type |
Return | osid.sequencing.records.AntimatroidQueryRecord | the antimatroid query record | |
Errors | NULL_ARGUMENT | antimatroidRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(antimatroidRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |