Interface | osid.profile.ProfileEntryProfileSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | useComparativeProfileView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryProfileView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | canLookupProfileEntryProfileMappings | ||
Description |
Tests if this user can perform lookups of profile
entry/profile mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryIdsByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileId | Id of a Profile |
Return | osid.id.IdList | list of related profile entry Ids | |
Errors | NOT_FOUND | profileId is not found | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileId | Id of a Profile |
Return | osid.profile.ProfileEntryList | list of related profile entry | |
Errors | NOT_FOUND | profileId is not found | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesIdsByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | profileIds | list of profile Ids |
Return | osid.id.IdList | list of profile entry Ids | |
Errors | NULL_ARGUMENT | profileIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | profileIds | list of profile Ids |
Return | osid.profile.ProfileEntryList | list of profile entries | |
Errors | NULL_ARGUMENT | profileIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileIdsByProfileEntry | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileEntryId | Id of a ProfileEntry |
Return | osid.id.IdList | list of profile Ids | |
Errors | NOT_FOUND | profileEntryId is not found | |
NULL_ARGUMENT | profileEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileByProfileEntry | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileEntryId | Id of a ProfileEntry |
Return | osid.profile.ProfileList | list of profile | |
Errors | NOT_FOUND | profileEntryId is not found | |
NULL_ARGUMENT | profileEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |