Interface | osid.profile.ProfileItemProfileSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines two views:
| ||
Method | canLookupProfileItemProfileMappings | ||
Description |
Tests if this user can perform lookups of profile/item
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 | 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 | getProfileItemIdsByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileId | Id of the Profile |
Return | osid.id.IdList | list of related profile item 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 | getProfileItemsByProfile | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileId | Id of the Profile |
Return | osid.profile.ProfileItemList | list of related profile items | |
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 | getProfileItemIdsByProfiles | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | profileIds | list of profile Ids |
Return | osid.id.IdList | list of profile item 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 | getProfileItemsByProfiles | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | profileIds | list of profile Ids |
Return | osid.profile.ProfileItemList | list of profile items | |
Errors | NULL_ARGUMENT | profileIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileIdsByProfileItem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileItemId | Id of a ProfileItem |
Return | osid.id.IdList | list of profile Ids | |
Errors | NOT_FOUND | profileItemId is not found | |
NULL_ARGUMENT | profileItemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfilesByProfileItem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | profileItemId | Id of a ProfileItem |
Return | osid.profile.ProfileList | list of profiles | |
Errors | NOT_FOUND | profileItemId is not found | |
NULL_ARGUMENT | profileItemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |