Interface | osid.room.construction.ProjectSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProjects | ||
Description |
Gets the project list resulting from a search. | ||
Return | osid.room.construction.ProjectList | the project list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProjectQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.room.construction.ProjectQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProjectSearchResultsRecord | ||
Description |
Gets the project search results record corresponding to the given project search record Type. This method is used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | projectSearchRecordType | a project search record type |
Return | osid.room.construction.records.ProjectSearchResultsRecord | the project search results record | |
Errors | NULL_ARGUMENT | projectSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(projectSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |