Interface | osid.profile.rules.ProfileEntryEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching profile entry enablers.
Each method match specifies an | ||
Method | matchRuledProfileEntryId | ||
Description |
Matches enablers mapped to the profile entry. | ||
Parameters | osid.id.Id | profileEntryId | the profile entry Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | profileEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledProfileEntryIdTerms | ||
Description |
Clears the profile entry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledProfileEntryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a profile entry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledProfileEntryQuery | ||
Description |
Gets the query for a profile entry. Multiple retrievals
produce a nested | ||
Return | osid.profile.ProfileEntryQuery | the profile entry query | |
Errors | UNIMPLEMENTED | supportsRuledProfileEntryQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledProfileEntryQuery()
is true. | |
Method | matchAnyRuledProfileEntry | ||
Description |
Matches enablers mapped to any profile entry. | ||
Parameters | boolean | match | true for enablers mapped to any profile entry, false
to match enablers mapped to no profile entry |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledProfileEntryTerms | ||
Description |
Clears the profile entry query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProfileId | ||
Description |
Matches enablers mapped to the profile. | ||
Parameters | osid.id.Id | profileId | the profile Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | profileId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearProfileIdTerms | ||
Description |
Clears the profile | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProfileQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a profile query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileQuery | ||
Description |
Gets the query for a profile. Multiple retrievals
produce a nested | ||
Return | osid.profile.ProfileQuery | the profile query | |
Errors | UNIMPLEMENTED | supportsProfileQuery() is false | |
Compliance | optional | This method must be implemented if supportsProfileQuery() is
true. | |
Method | clearProfileTerms | ||
Description |
Clears the profile query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerQueryRecord | ||
Description |
Gets the profile entry enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | profileEntryEnablerRecordType | a profile entry enabler record type |
Return | osid.profile.rules.records.ProfileEntryEnablerQueryRecord | the profile entry enabler query record | |
Errors | NULL_ARGUMENT | profileEntryEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(profileEntryEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |