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

This is the basic session for querying profiles.

MethodgetProfileId
Description

Gets the Profile Id associated with this session.

Returnosid.id.Idthe Profile Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProfile
Description

Gets the Profile associated with this session.

Returnosid.profile.Profilethe Profile associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessProfileEntries
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 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 profile methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedProfileView
Description

Federates the view for methods in this session. A federated view will include profile entries from descendant profiles in the profile hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedProfileView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this profile only.

CompliancemandatoryThis method is must be implemented.
MethodhasProfileEntry
Description

Determines if the question Id of the profile entry is true.

Parametersosid.id.IdprofileItemIdthe Id of a ProfileItem
Returnboolean true if the the profile question is true, false othersise
ErrorsNULL_ARGUMENT profileItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure making request
CompliancemandatoryThis 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 ProfileItem hierarchy. The provider needs to maintain a de-normalized implicit profile entry store or expand the applicable hierarchies on the fly to honor this query.

MethodgetProfileEntryCondition
Description

Gets the ProfileEntryCondition for making conditional profile checks.

Parametersosid.id.IdprofileItemIdthe Id of a ProfileItem
Returnosid.profile.ProfileEntryConditiona profil entry condition
ErrorsNULL_ARGUMENT profileItemId is null
CompliancemandatoryThis method must be implemented.
MethodhasProfileEntryOnCondition
Description

Determines if the question Id of the profile entry is true.

Parametersosid.id.IdprofileItemIdthe Id of a ProfileItem
osid.profile.ProfileEntryConditionconditiona profile entry condition
Returnboolean true if the profile entry is true, false othersise
ErrorsNULL_ARGUMENT profileItemId or condition is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure making request
UNSUPPORTED condition is not of this service
CompliancemandatoryThis 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 ProfileItem hierarchy. The provider needs to maintain a de-normalized implicit entry store or expand the applicable hierarchies on the fly to honor this query.