OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
workflow package
Version 3.0.0
Release Candidate Preview
| Interface | osid.workflow.StepQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining step queries. | ||
| Method | getProcessIdTerms | ||
| Description |
Gets the process | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessTerms | ||
| Description |
Gets the process query terms. | ||
| Return | osid.workflow.ProcessQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkIdTerms | ||
| Description |
Gets the work | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkTerms | ||
| Description |
Gets the work query terms. | ||
| Return | osid.workflow.WorkQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInitialTerms | ||
| Description |
Gets the initial step query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTerminalTerms | ||
| Description |
Gets the terminal step query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputStateIdTerms | ||
| Description |
Gets the input state | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputStateTerms | ||
| Description |
Gets the input state query terms. | ||
| Return | osid.process.StateQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextStateIdTerms | ||
| Description |
Gets the next state | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextStateTerms | ||
| Description |
Gets the next state query terms. | ||
| Return | osid.process.StateQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficeIdTerms | ||
| Description |
Gets the office | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficeTerms | ||
| Description |
Gets the office query terms. | ||
| Return | osid.workflow.OfficeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepQueryInspectorRecord | ||
| Description |
Gets the step query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | stepRecordType | a step record type |
| Return | osid.workflow.records.StepQueryInspectorRecord | the step query inspector 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. | |