Interface | osid.profile.ProfileSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProfiles | ||
Description |
Gets the profile list resulting from the search. | ||
Return | osid.profile.ProfileList | the profile list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.profile.ProfileQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileSearchResultsRecord | ||
Description |
Gets the profile search results record corresponding to
the given profile search record | ||
Parameters | osid.type.Type | profileSearchRecordType | a profile search record type |
Return | osid.profile.records.ProfileSearchResultsRecord | the profile search results record | |
Errors | NULL_ARGUMENT | profileSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(profileSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |