Interface | osid.workflow.rules.StepConstrainerEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching step constrainer enablers.
Each method match specifies a | ||
Method | matchRuledStepConstrainerId | ||
Description |
Matches enablers mapped to the step constrainer. | ||
Parameters | osid.id.Id | stepConstrainerId | the step constrainer Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stepConstrainerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepConstrainerIdTerms | ||
Description |
Clears the step constrainer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledStepConstrainerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a step constrainer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledStepConstrainerQuery | ||
Description |
Gets the query for a step constrainer. Multiple
retrievals produce a nested | ||
Return | osid.workflow.rules.StepConstrainerQuery | the step constrainer query | |
Errors | UNIMPLEMENTED | supportsRuledStepConstrainerQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRuledStepConstrainerQuery() is true. | |
Method | matchAnyRuledStepConstrainer | ||
Description |
Matches enablers mapped to any step constrainer. | ||
Parameters | boolean | match | true for enablers mapped to any step constrainer,
false to match enablers mapped to no step constrainers |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepConstrainerTerms | ||
Description |
Clears the step constrainer 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 | getStepConstrainerEnablerQueryRecord | ||
Description |
Gets the step constrainer enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | stepConstrainerEnablerRecordType | a step constrainer enabler record type |
Return | osid.workflow.rules.records.StepConstrainerEnablerQueryRecord | the step constrainer enabler query record | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stepConstrainerEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |