Interface | osid.workflow.WorkQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching works. Each method match
specifies an | ||
Method | matchSuspended | ||
Description |
Matches suspended work. | ||
Parameters | boolean | match | true to match suspended work, false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearSuspendedTerms | ||
Description |
Clears the suspended query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProcessId | ||
Description |
Sets the 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 | clearProcessIdTerms | ||
Description |
Clears the process | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcessQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a process query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessQuery | ||
Description |
Gets the query for a process. Multiple retrievals
produce a nested | ||
Return | osid.workflow.ProcessQuery | the process query | |
Errors | UNIMPLEMENTED | supportsProcessQuery() is false | |
Compliance | optional | This method must be implemented if supportsProcessQuery() is
true. | |
Method | clearProcessTerms | ||
Description |
Clears the process query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchStepId | ||
Description |
Sets the 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 | clearStepIdTerms | ||
Description |
Clears the step | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsStepQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a step query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepQuery | ||
Description |
Gets the query for a step Multiple retrievals produce a
nested | ||
Return | osid.workflow.StepQuery | the step query | |
Errors | UNIMPLEMENTED | supportsStepyQuery() is false | |
Compliance | optional | This method must be implemented if supportsStepQuery() is
true. | |
Method | matchAnyStep | ||
Description |
Matches processes that have any step. | ||
Parameters | boolean | match | true to match processes with any step, false
to match processes with no step |
Compliance | mandatory | This method must be implemented. | |
Method | clearStepTerms | ||
Description |
Clears the step query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOfficeId | ||
Description |
Sets 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 a | ||
Return | boolean | true if a office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeQuery | ||
Description |
Gets the query for a 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 | getWorkQueryRecord | ||
Description |
Gets the work query record corresponding to the given
| ||
Parameters | osid.type.Type | workRecordType | a work record type |
Return | osid.workflow.records.WorkQueryRecord | the work query record | |
Errors | NULL_ARGUMENT | workRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(workRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |