Interface | osid.workflow.rules.StepProcessorEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching step processor enablers.
Each method match specifies a | ||
Method | matchRuledStepProcessorId | ||
Description |
Matches enablers mapped to the step processor. | ||
Parameters | osid.id.Id | stepProcessorId | the step processor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stepProcessorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepProcessorIdTerms | ||
Description |
Clears the step processor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledStepProcessorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a step processor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledStepProcessorQuery | ||
Description |
Gets the query for a step processor. Multiple
retrievals produce a nested | ||
Return | osid.workflow.rules.StepProcessorQuery | the step processor query | |
Errors | UNIMPLEMENTED | supportsRuledStepProcessorQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledStepProcessorQuery()
is true. | |
Method | matchAnyRuledStepProcessor | ||
Description |
Matches enablers mapped to any step processor. | ||
Parameters | boolean | match | true for enablers mapped to any step processor, false
to match enablers mapped to no step processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepProcessorTerms | ||
Description |
Clears the step processor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOfficeId | ||
Description |
Matches enablers mapped to the office. | ||
Parameters | osid.id.Id | officeId | the office Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | officeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOfficeIdTerms | ||
Description |
Clears the office | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOfficeQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeQuery | ||
Description |
Gets the query for an office. Multiple retrievals
produce a nested | ||
Return | osid.workflow.OfficeQuery | the office query | |
Errors | UNIMPLEMENTED | supportsOfficeQuery() is false | |
Compliance | optional | This method must be implemented if supportsOfficeQuery() is
true. | |
Method | clearOfficeTerms | ||
Description |
Clears the office query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorEnablerQueryRecord | ||
Description |
Gets the step processor enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | stepProcessorEnablerRecordType | a step processor enabler record type |
Return | osid.workflow.rules.records.StepProcessorEnablerQueryRecord | the step processor enabler query record | |
Errors | NULL_ARGUMENT | stepProcessorEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stepProcessorEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |