Interface | osid.profile.ProfileEntrySearchSession | ||
---|---|---|---|
Implements | osid.profile.ProfileEntryQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
| ||
Method | getProfileEntrySearch | ||
Description |
Gets a profile entry search. | ||
Return | osid.profile.ProfileEntrySearch | the profile entry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntrySearchOrder | ||
Description |
Gets a profile entry search order. The | ||
Return | osid.profile.ProfileEntrySearchOrder | the profile entry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.profile.ProfileEntryQuery | profileEntryQuery | the profile entry query |
osid.profile.ProfileEntrySearch | profileEntrySearch | the profile entry search | |
Return | osid.profile.ProfileEntrySearchResults | the returned search results | |
Errors | NULL_ARGUMENT | profileEntryQuery or profileEntrySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileEntryQuery or profileEntrySearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryQueryFromInspector | ||
Description |
Gets a profile entry query from an inspector. The
inspector is available from an | ||
Parameters | osid.profile.ProfileEntryQueryInspector | profileEntryQueryInspector | a profile entry query inspector |
Return | osid.profile.ProfileEntryQuery | the profile entry query | |
Errors | NULL_ARGUMENT | profileEntryQueryInspector is null | |
UNSUPPORTED | pofileEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |