Interface | osid.profile.ProfileEntryQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
| ||
Method | getProfileId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Profile Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfile | ||
Description |
Gets the | ||
Return | osid.profile.Profile | the Profile associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchProfileEntries | ||
Description |
Tests if this user can perform profile entry searches.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedProfileView | ||
Description |
Federates the view for methods in this session. A federated view will include profile entries in profiles which are children of this profile in the profile hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedProfileView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this profile only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useImplicitProfileEntryView | ||
Description |
Sets the view for methods in this session to implicit
profile entry. An implicit view will include entries
derived from other profile entries as a result of the
| ||
Compliance | mandatory | This method is must be implemented. | |
Method | useExplicitProfileEntryView | ||
Description |
Sets the view for methods in this session to explicit
proffile entries. An explicit view includes only those
entries that were explicitly defined and not implied. This
method is the opposite of | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProfileEntryQuery | ||
Description |
Gets a profile entry query. | ||
Return | osid.profile.ProfileEntryQuery | the profile entry query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.profile.ProfileEntryQuery | profileEntryQuery | the profile entry query |
Return | osid.profile.ProfileEntryList | the returned ProfileEntryList | |
Errors | NULL_ARGUMENT | profileEntryQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileEntryQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |