Interface | osid.workflow.rules.ProcessEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching process enablers. Each
method match specifies an | ||
Method | matchRuledProcessId | ||
Description |
Matches enablers mapped to a process. | ||
Parameters | osid.id.Id | processId | the process Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | processId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledProcessIdTerms | ||
Description |
Clears the process | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledProcessQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a process query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledProcessQuery | ||
Description |
Gets the query for a process. Multiple retrievals
produce a nested | ||
Return | osid.workflow.ProcessQuery | the process query | |
Errors | UNIMPLEMENTED | supportsRuledProcessQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledProcessQuery()
is true. | |
Method | matchAnyRuledProcess | ||
Description |
Matches rules mapped to any process. | ||
Parameters | boolean | match | true for rules mapped to any process, false
to match rules mapped to no processs |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledProcessTerms | ||
Description |
Clears the process query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOfficeId | ||
Description |
Matches enablers mapped to an 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 | getProcessEnablerQueryRecord | ||
Description |
Gets the process enabler query record corresponding to
the given | ||
Parameters | osid.type.Type | processEnablerRecordType | a process enabler record type |
Return | osid.workflow.rules.records.ProcessEnablerQueryRecord | the process enabler query record | |
Errors | NULL_ARGUMENT | processEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(processEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |