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

This session provides methods for searching among Profile objects. 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
CompliancemandatoryThis method must be implemented.
MethodgetProfileQuery
Description

Gets a profile query.

Returnosid.profile.ProfileQuerya profile query
CompliancemandatoryThis method must be implemented.
MethodgetProfilesByQuery
Description

Gets a list of Profiles matching the given profile query.

Parametersosid.profile.ProfileQueryprofileQuerythe profile query
Returnosid.profile.ProfileListthe returned ProfileList
ErrorsNULL_ARGUMENT profileQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileQuery is not of this service
CompliancemandatoryThis method must be implemented.