Interface | osid.sequencing.ChainQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching chains. Each method match
specifies an | ||
Method | matchFifo | ||
Description |
Matches fifo chains. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearFifoTerms | ||
Description |
Clears the fifo query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchElement | ||
Description |
Sets the element | ||
Parameters | osid.id.Id | elementId | the element Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | elementId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyElement | ||
Description |
Matches chains with any element. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearElementTerms | ||
Description |
Clears the element query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAntimatroidId | ||
Description |
Sets the action group | ||
Parameters | osid.id.Id | actionGroupId | the action group Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | actionGroupId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAntimatroidIdTerms | ||
Description |
Clears the antimatroid | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAntimatroidQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an antimatroid query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroidQuery | ||
Description |
Gets the query for an antimatroid. Multiple retrievals
produce a nested | ||
Return | osid.sequencing.AntimatroidQuery | the antimatroid query | |
Errors | UNIMPLEMENTED | supportsAntimatroidQuery() is false | |
Compliance | optional | This method must be implemented if supportsAntimatroidQuery()
is true. | |
Method | clearAntimatroidTerms | ||
Description |
Clears the antimatroid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainQueryRecord | ||
Description |
Gets the query record corresponding to the given | ||
Parameters | osid.type.Type | chainRecordType | a chain record type |
Return | osid.sequencing.records.ChainQueryRecord | the chain query record | |
Errors | NULL_ARGUMENT | chainRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(chainRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |