org.osid.profile.rules

Interface ProfileEntryEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface ProfileEntryEnablerQuery
extends OsidEnablerQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearProfileIdTerms() Clears the profile Id query terms.
void	clearProfileTerms() Clears the profile query terms.
void	clearRuledProfileEntryIdTerms() Clears the profile entry Id query terms.
void	clearRuledProfileEntryTerms() Clears the profile entry query terms.
ProfileEntryEnablerQueryRecord	getProfileEntryEnablerQueryRecord(Type profileEntryEnablerRecordType) Gets the profile entry enabler query record corresponding to the given ProfileEntryEnabler record Type.
ProfileQuery	getProfileQuery() Gets the query for a profile.
ProfileEntryQuery	getRuledProfileEntryQuery() Gets the query for a profile entry.
void	matchAnyRuledProfileEntry(boolean match) Matches enablers mapped to any profile entry.
void	matchProfileId(Id profileId, boolean match) Matches enablers mapped to the profile.
void	matchRuledProfileEntryId(Id profileEntryId, boolean match) Matches enablers mapped to the profile entry.
boolean	supportsProfileQuery() Tests if a ProfileQuery is available.
boolean	supportsRuledProfileEntryQuery() Tests if a ProfileEntryQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledProfileEntryId

void matchRuledProfileEntryId(Id profileEntryId,
                            boolean match)

Matches enablers mapped to the profile entry.

Parameters:

profileEntryId - the profile entry Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - profileEntryId is null

Compliance:

mandatory - This method must be implemented.

clearRuledProfileEntryIdTerms

void clearRuledProfileEntryIdTerms()

Clears the profile entry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledProfileEntryQuery

boolean supportsRuledProfileEntryQuery()

Tests if a ProfileEntryQuery is available.

Returns:

true if a profile entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledProfileEntryQuery

ProfileEntryQuery getRuledProfileEntryQuery()

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

Returns:

the profile entry query

Throws:

UnimplementedException - supportsRuledProfileEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsRuledProfileEntryQuery() is true.

matchAnyRuledProfileEntry

void matchAnyRuledProfileEntry(boolean match)

Matches enablers mapped to any profile entry.

Parameters:

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.

clearRuledProfileEntryTerms

void clearRuledProfileEntryTerms()

Clears the profile entry query terms.

Compliance:

mandatory - This method must be implemented.

matchProfileId

void matchProfileId(Id profileId,
                  boolean match)

Matches enablers mapped to the profile.

Parameters:

profileId - the profile Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - profileId is null

Compliance:

mandatory - This method must be implemented.

clearProfileIdTerms

void clearProfileIdTerms()

Clears the profile Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProfileQuery

boolean supportsProfileQuery()

Tests if a ProfileQuery is available.

Returns:

true if a profile query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileQuery

ProfileQuery getProfileQuery()

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

Returns:

the profile query

Throws:

UnimplementedException - supportsProfileQuery() is false

Compliance:

optional - This method must be implemented if supportsProfileQuery() is true.

clearProfileTerms

void clearProfileTerms()

Clears the profile query terms.

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablerQueryRecord

ProfileEntryEnablerQueryRecord getProfileEntryEnablerQueryRecord(Type profileEntryEnablerRecordType)
                                                                 throws OperationFailedException

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

Parameters:

profileEntryEnablerRecordType - a profile entry enabler record type

Returns:

the profile entry enabler query record

Throws:

NullArgumentException - profileEntryEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.