Interface | osid.workflow.StepQuery | ||
---|---|---|---|
Implements | osid.OsidGovernatorQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching steps. Each method match
specifies an | ||
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 | matchResourceId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | matchAnyResource | ||
Description |
Matches steps that have any resources. | ||
Parameters | boolean | match | true to match steps with any resources, false
to match steps with no resources |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInitial | ||
Description |
Matches initial steps. | ||
Parameters | boolean | match | true to match initial steps, false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearInitialTerms | ||
Description |
Clears the initial step terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTerminal | ||
Description |
Matches terminal steps. | ||
Parameters | boolean | match | true to match terminal steps, false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearTerminalTerms | ||
Description |
Clears the terminal step terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInputStateId | ||
Description |
Sets the input state | ||
Parameters | osid.id.Id | stateId | the state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInputStateIdTerms | ||
Description |
Clears the input state | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputStateQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a state query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputStateQuery | ||
Description |
Gets the query for an input state. Multiple retrievals
produce a nested | ||
Return | osid.process.StateQuery | the state query | |
Errors | UNIMPLEMENTED | supportsInputStateQuery() is false | |
Compliance | optional | This method must be implemented if supportsInputtStateQuery()
is true. | |
Method | matchAnyInputState | ||
Description |
Matches steps that have any input states. | ||
Parameters | boolean | match | true to match steps with any input states, false
to match steps with no input states |
Compliance | mandatory | This method must be implemented. | |
Method | clearInputStateTerms | ||
Description |
Clears the input state terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchNextStateId | ||
Description |
Sets the next state | ||
Parameters | osid.id.Id | stateId | the state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearNextStateIdTerms | ||
Description |
Clears the next state | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsNextStateQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a state query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getNextStateQuery | ||
Description |
Gets the query for a state. Multiple retrievals produce
a nested | ||
Return | osid.process.StateQuery | the state query | |
Errors | UNIMPLEMENTED | supportsNextStateQuery() is false | |
Compliance | optional | This method must be implemented if supportsNextStateQuery()
is true. | |
Method | matchAnyNextState | ||
Description |
Matches steps that have any next state, | ||
Parameters | boolean | match | true to match steps with any next state, false
to match steps with no next state |
Compliance | mandatory | This method must be implemented. | |
Method | clearNextStateTerms | ||
Description |
Clears the state terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWorkId | ||
Description |
Sets the work | ||
Parameters | osid.id.Id | workId | the work Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | workId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearWorkIdTerms | ||
Description |
Clears the work | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsWorkQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a work query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkQuery | ||
Description |
Gets the query for a work. Multiple retrievals produce
a nested | ||
Return | osid.workflow.WorkQuery | the work query | |
Errors | UNIMPLEMENTED | supportsWorkQuery() is false | |
Compliance | optional | This method must be implemented if supportsWorkQuery() is
true. | |
Method | matchAnyWork | ||
Description |
Matches steps that have any work. | ||
Parameters | boolean | match | true to match steps with any work, false to
match steps with no work |
Compliance | mandatory | This method must be implemented. | |
Method | clearWorkTerms | ||
Description |
Clears the work 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 | getStepQueryRecord | ||
Description |
Gets the step query record corresponding to the given
| ||
Parameters | osid.type.Type | stepRecordType | a step record type |
Return | osid.workflow.records.StepQueryRecord | the step query record | |
Errors | NULL_ARGUMENT | stepRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stepRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |