Interface | osid.profile.ProfileEntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProfileEntries | ||
Description |
Gets the profile entry list resulting from the search. | ||
Return | osid.profile.ProfileEntryList | the profile entry list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.profile.ProfileEntryQueryInspector | the profile entry query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntrySearchResultsRecord | ||
Description |
Gets the profile entry search results record
corresponding to the given profile entry search record
| ||
Parameters | osid.type.Type | profileEntrySearchRecordType | a profile entry search record type |
Return | osid.profile.records.ProfileEntrySearchResultsRecord | the profile entry search results record | |
Errors | NULL_ARGUMENT | profileEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(profileEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |