Interface | osid.profile.rules.ProfileEntryEnablerSearchSession | ||
---|---|---|---|
Implements | osid.profile.rules.ProfileEntryEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getProfileEntryEnablerSearch | ||
Description |
Gets a profile entry enabler search. | ||
Return | osid.profile.rules.ProfileEntryEnablerSearch | the profile entry enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerSearchOrder | ||
Description |
Gets a profile entry enabler search order. The | ||
Return | osid.profile.rules.ProfileEntryEnablerSearchOrder | the profile entry enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.profile.rules.ProfileEntryEnablerQuery | profileEntryEnablerQuery | the profile entry enabler query |
osid.profile.rules.ProfileEntryEnablerSearch | profileEntryEnablerSearch | the profile entry enabler search | |
Return | osid.profile.rules.ProfileEntryEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | profileEntryEnablerQuery or profileEntryEnablerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileEntryEnablerQuery or profileEntryEnablerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerQueryFromInspector | ||
Description |
Gets a profile entry enabler query from an inspector.
The inspector is available from a | ||
Parameters | osid.profile.rules.ProfileEntryEnablerQueryInspector | profileEntryEnablerQueryInspector | a profile entry enabler query inspector |
Return | osid.profile.rules.ProfileEntryEnablerQuery | the profile entry enabler query | |
Errors | NULL_ARGUMENT | profileEntryEnablerQueryInspector is null | |
UNSUPPORTED | profileEntryEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |