Interface | osid.profile.ProfilingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This is the basic session for querying profiles. | ||
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 | canAccessProfileEntries | ||
Description |
Tests if this user can perform profile checks. 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 profile 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 from descendant profiles 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 | hasProfileEntry | ||
Description |
Determines if the question | ||
Parameters | osid.id.Id | profileItemId | the Id of a ProfileItem |
Return | boolean | true if the the profile question is true, false
othersise | |
Errors | NULL_ARGUMENT | profileItemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure making request | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
Profile entries may be stored in a normalized form with
respect to various Resources and created using specific
nodes in a | ||
Method | getProfileEntryCondition | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileItemId | the Id of a ProfileItem |
Return | osid.profile.ProfileEntryCondition | a profil entry condition | |
Errors | NULL_ARGUMENT | profileItemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | hasProfileEntryOnCondition | ||
Description |
Determines if the question | ||
Parameters | osid.id.Id | profileItemId | the Id of a ProfileItem |
osid.profile.ProfileEntryCondition | condition | a profile entry condition | |
Return | boolean | true if the profile entry is true, false
othersise | |
Errors | NULL_ARGUMENT | profileItemId or condition is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure making request | ||
UNSUPPORTED | condition is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
ProfileEntries may be stored in a normalized form with
respect to various Resources and created using specific
nodes in a |