Interface | osid.profile.ProfileItemSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProfileItems | ||
Description |
Gets the profile item list resulting from the search. | ||
Return | osid.profile.ProfileItemList | the profile item list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.profile.ProfileItemQueryInspector | the profile item query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemSearchResultsRecord | ||
Description |
Gets the profile search results record corresponding to
the given profile item search record | ||
Parameters | osid.type.Type | profileItemSearchRecordType | a profile item search record type |
Return | osid.profile.records.ProfileItemSearchResultsRecord | the profile item search results record | |
Errors | NULL_ARGUMENT | profileItemSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(profileItemSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |