OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileQuerySession
Implementsosid.OsidSession
Implemented Byosid.profile.ProfileSearchSession
Used Byosid.profile.ProfileManager
osid.profile.ProfileProxyManager
Description

This session provides methods for searching among Profiles. The search query is constructed using the ProfileQuery.

Profiles may have a profile record indicated by their respective record types. The profile record is accessed via the ProfileQuery.

MethodcanSearchProfiles
Description

Tests if this user can perform Profile searches. 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetProfileQuery
Description

Gets a profile query.

Returnosid.profile.ProfileQuery a profile query
Compliancemandatory This method must be implemented.
MethodgetProfilesByQuery
Description

Gets a list of Profiles matching the given profile query.

Parametersosid.profile.ProfileQueryprofileQuery the profile query
Returnosid.profile.ProfileList the returned ProfileList
ErrorsNULL_ARGUMENT profileQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED profileQuery is not of this service
Compliancemandatory This method must be implemented.