Interface | osid.workflow.rules.StepConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching step constrainers. Each
method match specifies a | ||
Method | matchRuledStepId | ||
Description |
Matches mapped to a step. | ||
Parameters | osid.id.Id | stepId | the step Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stepId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepIdTerms | ||
Description |
Clears the step | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledStepQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a step query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledStepQuery | ||
Description |
Gets the query for a step. Multiple retrievals produce
a nested | ||
Return | osid.workflow.StepQuery | the step query | |
Errors | UNIMPLEMENTED | supportsRuledStepQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledStepQuery()
is true. | |
Method | matchAnyRuledStep | ||
Description |
Matches constrainers mapped to any step. | ||
Parameters | boolean | match | true for constrainers mapped to any step, false
to match constrainers mapped to no steps |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledStepTerms | ||
Description |
Clears the step query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOfficeId | ||
Description |
Matches constrainers 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 | getStepConstrainerQueryRecord | ||
Description |
Gets the step constrainer query record corresponding to
the given | ||
Parameters | osid.type.Type | stepConstrainerRecordType | a step constrainer record type |
Return | osid.workflow.rules.records.StepConstrainerQueryRecord | the step constrainer query record | |
Errors | NULL_ARGUMENT | stepConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stepConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |