| Interface | osid.workflow.rules.ProcessConstrainerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.workflow.rules.ProcessConstrainerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProcessConstrainers | ||
| Description |
Gets the process constrainer list resulting from a search. | ||
| Return | osid.workflow.rules.ProcessConstrainerList | the process constrainer list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessConstrainerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.workflow.rules.ProcessConstrainerQueryInspector | the process constrainer query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessConstrainerSearchResultsRecord | ||
| Description |
Gets the process constrainer search results record
corresponding to the given process constrainer search
record | ||
| Parameters | osid.type.Type | processConstrainerSearchRecordType | a process constrainer search record type |
| Return | osid.workflow.rules.records.ProcessConstrainerSearchResultsRecord | the process constrainer search results record | |
| Errors | NULL_ARGUMENT | processConstrainerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(processConstrainerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |