Interface | osid.provisioning.rules.QueueProcessorQuery | ||
---|---|---|---|
Implements | osid.OsidProcessorQuery | ||
Description |
This is the query for searching queue processors. Each
method match specifies a | ||
Method | matchAutomatic | ||
Description |
Matches automatic processors. | ||
Parameters | boolean | match | true to match automatic processors, false to
match manual processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearAutomaticTerms | ||
Description |
Clears the automatic query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFifo | ||
Description |
Matches first-in-first-out processors. | ||
Parameters | boolean | match | true to match fifo processors, false
otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearFifoTerms | ||
Description |
Clears the fifo query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRemovesProcessedQueueEntries | ||
Description |
Matches processors that remove processed queue entries. | ||
Parameters | boolean | match | true to match removing queue entry processors, false
otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearRemovesProcessedQueueEntriesTerms | ||
Description |
Clears the removes processed queue entries query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRuledQueueId | ||
Description |
Matches mapped to the queue. | ||
Parameters | osid.id.Id | queueId | the queue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | queueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueIdTerms | ||
Description |
Clears the queue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledQueueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a queue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledQueueQuery | ||
Description |
Gets the query for a queue. Multiple retrievals produce
a nested | ||
Return | osid.provisioning.QueueQuery | the queue query | |
Errors | UNIMPLEMENTED | supportsRuledQueueQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledQueueQuery()
is true. | |
Method | matchAnyRuledQueue | ||
Description |
Matches mapped to any queue. | ||
Parameters | boolean | match | true for mapped to any queue, false to match
mapped to no queue |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueTerms | ||
Description |
Clears the queue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDistributorId | ||
Description |
Matches mapped to the distributor. | ||
Parameters | osid.id.Id | distributorId | the distributor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | distributorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDistributorIdTerms | ||
Description |
Clears the distributor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a distributor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorQuery | ||
Description |
Gets the query for a distributor. Multiple retrievals
produce a nested | ||
Return | osid.provisioning.DistributorQuery | the distributor query | |
Errors | UNIMPLEMENTED | supportsDistributorQuery() is false | |
Compliance | optional | This method must be implemented if supportsDistributorQuery()
is true. | |
Method | clearDistributorTerms | ||
Description |
Clears the distributor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorQueryRecord | ||
Description |
Gets the queue processor query record corresponding to
the given | ||
Parameters | osid.type.Type | queueProcessorRecordType | a queue processor record type |
Return | osid.provisioning.rules.records.QueueProcessorQueryRecord | the queue processor query record | |
Errors | NULL_ARGUMENT | queueProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueProcessorRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |