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

This session provides methods for retrieving Profile objects. The Profile represents a collection of ProfileItems and ProfileEntries.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Profiles it can access, without breaking execution. However, an administrative application may require all Profile elements to be available.

Profiles may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Profile.

MethodcanLookupProfiles
Description

Tests if this user can perform Profile lookups. 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 lookup methods are 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 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.
MethodgetProfile
Description

Gets the Profile specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Profile may have a different Id than requested, such as the case where a duplicate Id was assigned to a Profile and retained for compatibility.

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

Gets a ProfileList corresponding to the given IdList. In plenary mode, the returned list contains all of the profiles specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Profile objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListprofileIdsthe list of Ids to retrieve
Returnosid.profile.ProfileListthe returned Profile list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT profileIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByGenusType
Description

Gets a ProfileList corresponding to the given profile genus Type which does not include profiles of types derived from the specified Type. In plenary mode, the returned list contains all known profiles or an error results. Otherwise, the returned list may contain only those profiles that are accessible through this session.

Parametersosid.type.TypeprofileGenusTypea profile genus type
Returnosid.profile.ProfileListthe returned Profile list
ErrorsNULL_ARGUMENT profileGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByParentGenusType
Description

Gets a ProfileList corresponding to the given profile genus Type and include any additional profiles with genus types derived from the specified Type. In plenary mode, the returned list contains all known profiles or an error results. Otherwise, the returned list may contain only those profiles that are accessible through this session.

Parametersosid.type.TypeprofileGenusTypea profile genus type
Returnosid.profile.ProfileListthe returned Profile list
ErrorsNULL_ARGUMENT profileGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByRecordType
Description

Gets a ProfileList containing the given profile record Type. In plenary mode, the returned list contains all known profiles or an error results. Otherwise, the returned list may contain only those profiles that are accessible through this session.

Parametersosid.type.TypeprofileRecordTypea profile record type
Returnosid.profile.ProfileListthe returned Profile list
ErrorsNULL_ARGUMENT profileRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByProvider
Description

Gets a ProfileList for the given provider. In plenary mode, the returned list contains all known profiles or an error results. Otherwise, the returned list may contain only those profiles that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.profile.ProfileListthe returned Profile list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfiles
Description

Gets all Profiles. In plenary mode, the returned list contains all known profiles or an error results. Otherwise, the returned list may contain only those profiles that are accessible through this session.

Returnosid.profile.ProfileLista ProfileList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.