Interface | osid.tracking.rules.QueueConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching queue constrainers. Each
method match specifies a | ||
Method | matchRuledQueueId | ||
Description |
Matches mapped to a 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.tracking.QueueQuery | the queue query | |
Errors | UNIMPLEMENTED | supportsRuledQueueQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledQueueQuery()
is true. | |
Method | matchAnyRuledQueue | ||
Description |
Matches constrainers mapped to any queue. | ||
Parameters | boolean | match | true for constrainers mapped to any queue, false
to match constrainers mapped to no queues |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueTerms | ||
Description |
Clears the queue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFrontOfficeId | ||
Description |
Matches constrainers mapped to the front office. | ||
Parameters | osid.id.Id | frontOfficeId | the front office Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFrontOfficeIdTerms | ||
Description |
Clears the front office | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFrontOfficeQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a front office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeQuery | ||
Description |
Gets the query for a front office. Multiple retrievals
produce a nested | ||
Return | osid.tracking.FrontOfficeQuery | the front office query | |
Errors | UNIMPLEMENTED | supportsFrontOfficeQuery() is false | |
Compliance | optional | This method must be implemented if supportsFrontOfficeQuery()
is true. | |
Method | clearFrontOfficeTerms | ||
Description |
Clears the front office query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerQueryRecord | ||
Description |
Gets the queue constrainer query record corresponding
to the given | ||
Parameters | osid.type.Type | queueConstrainerRecordType | a queue constrainer record type |
Return | osid.tracking.rules.records.QueueConstrainerQueryRecord | the queue constrainer query record | |
Errors | NULL_ARGUMENT | queueConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |