Interface | osid.tracking.rules.QueueProcessorEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching queue processor enablers.
Each method match specifies a | ||
Method | matchRuledQueueProcessorId | ||
Description |
Matches enablers mapped to the queue processor. | ||
Parameters | osid.id.Id | queueProcessorId | the queue processor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | queueProcessorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueProcessorIdTerms | ||
Description |
Clears the queue processor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledQueueProcessorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a queue processor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledQueueProcessorQuery | ||
Description |
Gets the query for a queue processor. Multiple
retrievals produce a nested | ||
Return | osid.tracking.rules.QueueProcessorQuery | the queue processor query | |
Errors | UNIMPLEMENTED | supportsRuledQueueProcessorQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRuledQueueProcessorQuery() is true. | |
Method | matchAnyRuledQueueProcessor | ||
Description |
Matches enablers mapped to any queue processor. | ||
Parameters | boolean | match | true for enablers mapped to any queue processor,
false to match enablers mapped to no queue processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueProcessorTerms | ||
Description |
Clears the queue processor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFrontOfficeId | ||
Description |
Matches enablers 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 | getQueueProcessorEnablerQueryRecord | ||
Description |
Gets the queue processor enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | queueProcessorEnablerRecordType | a queue processor enabler record type |
Return | osid.tracking.rules.records.QueueProcessorEnablerQueryRecord | the queue processor enabler query record | |
Errors | NULL_ARGUMENT | queueProcessorEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueProcessorEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |