OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileItemProfileSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve ProfileItem to Profile mappings. A ProfileItem may appear in multiple Profiles. Each Profile may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupProfileItemProfileMappings
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProfileView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProfileView
Description

A complete view of the ProfileItem and Profile returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetProfileItemIdsByProfile
Description

Gets the list of ProfileItem Ids associated with a Profile.

Parametersosid.id.IdprofileId Id of the Profile
Returnosid.id.IdListlist of related profile item Ids
ErrorsNOT_FOUND profileId is not found
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemsByProfile
Description

Gets the list of ProfileItems associated with a Profile.

Parametersosid.id.IdprofileId Id of the Profile
Returnosid.profile.ProfileItemListlist of related profile items
ErrorsNOT_FOUND profileId is not found
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemIdsByProfiles
Description

Gets the list of ProfileItem Ids corresponding to a list of Profiles.

Parametersosid.id.IdListprofileIdslist of profile Ids
Returnosid.id.IdListlist of profile item Ids
ErrorsNULL_ARGUMENT profileIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemsByProfiles
Description

Gets the list of ProfileItems corresponding to a list of Profiles.

Parametersosid.id.IdListprofileIdslist of profile Ids
Returnosid.profile.ProfileItemListlist of profile items
ErrorsNULL_ARGUMENT profileIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileIdsByProfileItem
Description

Gets the list of Profile Ids mapped to a ProfileItem.

Parametersosid.id.IdprofileItemId Id of a ProfileItem
Returnosid.id.IdListlist of profile Ids
ErrorsNOT_FOUND profileItemId is not found
NULL_ARGUMENT profileItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByProfileItem
Description

Gets the list of Profiles mapped to a ProfileItem.

Parametersosid.id.IdprofileItemId Id of a ProfileItem
Returnosid.profile.ProfileListlist of profiles
ErrorsNOT_FOUND profileItemId is not found
NULL_ARGUMENT profileItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.