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

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

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
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 ProfileEntry 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.
MethodcanLookupProfileEntryProfileMappings
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 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.
MethodgetProfileEntryIdsByProfile
Description

Gets the list of ProfileEntry Ids associated with a Profile.

Parametersosid.id.IdprofileId Id of a Profile
Returnosid.id.IdListlist of related profile entry 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.
MethodgetProfileEntriesByProfile
Description

Gets the list of ProfileEntries associated with a Profile.

Parametersosid.id.IdprofileId Id of a Profile
Returnosid.profile.ProfileEntryListlist of related profile entry
ErrorsNOT_FOUND profileId is not found
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntriesIdsByProfile
Description

Gets the list of ProfileEntry Ids corresponding to a list of Profile objects.

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

Gets the list of ProfileEntries corresponding to a list of Profile.

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

Gets the list of Profile Ids mapped to a ProfileEntry.

Parametersosid.id.IdprofileEntryId Id of a ProfileEntry
Returnosid.id.IdListlist of profile Ids
ErrorsNOT_FOUND profileEntryId is not found
NULL_ARGUMENT profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileByProfileEntry
Description

Gets the list of Profile objects mapped to a ProfileEntry.

Parametersosid.id.IdprofileEntryId Id of a ProfileEntry
Returnosid.profile.ProfileListlist of profile
ErrorsNOT_FOUND profileEntryId is not found
NULL_ARGUMENT profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.