Interface | osid.profile.ProfileItemSearchSession | ||
---|---|---|---|
Implements | osid.profile.ProfileItemQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Profile items may have a profie item query record
indicated by their respective record types. The profile item
query record is accessed via the | ||
Method | getProfileItemSearch | ||
Description |
Gets a profile item search. | ||
Return | osid.profile.ProfileItemSearch | the profile item search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemSearchOrder | ||
Description |
Gets a profile item search order. The | ||
Return | osid.profile.ProfileItemSearchOrder | the profile item search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.profile.ProfileItemQuery | profileItemQuery | the profile item query |
osid.profile.ProfileItemSearch | profileItemSearch | the profile item search | |
Return | osid.profile.ProfileItemSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | profileItemQuery or profileItemSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileItemSearch or profileItemQuery is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemQueryFromInspector | ||
Description |
Gets a profile item query from an inspector. The
inspector is available from an | ||
Parameters | osid.profile.ProfileItemQueryInspector | profileItemQueryInspector | a profile item query inspector |
Return | osid.profile.ProfileItemQuery | the profile item query | |
Errors | NULL_ARGUMENT | profileItemQueryInspector is null | |
UNSUPPORTED | profileItemQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |