Interface | osid.profile.rules.ProfileEntryEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Profile entry enablers may have a profile entry enabler
query record indicated by their respective record types. The
profile entry enabler query record is accessed via the | ||
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 | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchProfileEntryEnablers | ||
Description |
Tests if this user can perform | ||
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 entry enablers in profiles which are children of this broker 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 lookups to this profile only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProfileEntryEnablerQuery | ||
Description |
Gets a profile entry enabler query. | ||
Return | osid.profile.rules.ProfileEntryEnablerQuery | the profile entry enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.profile.rules.ProfileEntryEnablerQuery | profileEntryEnablerQuery | the profile entry enabler query |
Return | osid.profile.rules.ProfileEntryEnablerList | the returned ProfileEntryEnablerList | |
Errors | NULL_ARGUMENT | profileEntryEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileEntryEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |