OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching profile entry enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledProfileEntryId
Description

Matches enablers mapped to the profile entry.

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

Clears the profile entry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledProfileEntryQuery
Description

Tests if a ProfileEntryQuery is available.

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

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

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

Matches enablers mapped to any profile entry.

Parametersbooleanmatch true for enablers mapped to any profile entry, false to match enablers mapped to no profile entry
CompliancemandatoryThis method must be implemented.
MethodclearRuledProfileEntryTerms
Description

Clears the profile entry query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProfileId
Description

Matches enablers mapped to the profile.

Parametersosid.id.IdprofileIdthe 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerQueryRecord
Description

Gets the profile entry enabler query record corresponding to the given ProfileEntryEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeprofileEntryEnablerRecordTypea profile entry enabler record type
Returnosid.profile.rules.records.ProfileEntryEnablerQueryRecordthe profile entry enabler query record
ErrorsNULL_ARGUMENT profileEntryEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileEntryEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.