OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileItemQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching profile items. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchProfileEntryId
Description

Sets the pofile entry Id for this query.

Parametersosid.id.IdprofileEntryIda profile entry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT profileEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearProfileEntryIdTerms
Description

Clears the profile entry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProfileEntryQuery
Description

Tests if an ProfileEntryQuery is available.

Returnboolean true if a profile entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryQuery
Description

Gets the query for a profile entry. Multiple retrievals produce a nested OR term.

Returnosid.profile.ProfileEntryQuerythe profile entry query
ErrorsUNIMPLEMENTED supportsProfileEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileEntryQuery() is true.
MethodmatchAnyProfileEntry
Description

Matches profile items that have any profile entry mapping.

Parametersbooleanmatch true to match items with any entry mapping, false to match items with no entry mapping
CompliancemandatoryThis method must be implemented.
MethodclearProfileEntryTerms
Description

Clears the profile entry query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProfileId
Description

Sets the profile Id for this query.

Parametersosid.id.IdprofileIda profile Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT profileId is null
CompliancemandatoryThis method must be implemented.
MethodclearProfileIdTerms
Description

Clears the profile Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProfileQuery
Description

Tests if a ProfileQuery is available.

Returnboolean true if a profile query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProfileQuery
Description

Gets the query for a profile. Multiple retrievals produce a nested OR term.

Returnosid.profile.ProfileQuerythe profile query
ErrorsUNIMPLEMENTED supportsProfileQuery() is false
ComplianceoptionalThis method must be implemented if supportsProfileQuery() is true.
MethodclearProfileTerms
Description

Clears the profile entry query terms.

CompliancemandatoryThis method must be implemented.
MethodgetProfileItemQueryRecord
Description

Gets the profile item query record corresponding to the given ProfileItem record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypeprofileItemRecordTypea profile item record type
Returnosid.profile.records.ProfileItemQueryRecordthe profile item query record
ErrorsNULL_ARGUMENT profileItemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileItemRecordType) is false
CompliancemandatoryThis method must be implemented.