org.osid.assessment.authoring

Interface SequenceRuleEnablerQuery

All Superinterfaces:

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

public interface SequenceRuleEnablerQuery
extends OsidEnablerQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBankIdTerms() Clears the bank Id query terms.
void	clearBankTerms() Clears the bank query terms.
void	clearRuledSequenceRuleIdTerms() Clears the sequence rule Id query terms.
void	clearRuledSequenceRuleTerms() Clears the sequence rule query terms.
BankQuery	getBankQuery() Gets the query for a bank.
SequenceRuleQuery	getRuledSequenceRuleQuery() Gets the query for a sequence rule.
SequenceRuleEnablerQueryRecord	getSequenceRuleEnablerQueryRecord(Type sequenceRuleEnablerRecordType) Gets the sequence rule enabler query record corresponding to the given SequenceRuleEnabler record Type.
void	matchAnyRuledSequenceRule(boolean match) Matches enablers mapped to any sequence rule.
void	matchBankId(Id bankId, boolean match) Matches enablers mapped to the bank.
void	matchRuledSequenceRuleId(Id sequenceRuleId, boolean match) Matches enablers mapped to the sequence rule.
boolean	supportsBankQuery() Tests if an BankQuery is available.
boolean	supportsRuledSequenceRuleQuery() Tests if a SequenceRuleQuery 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

matchRuledSequenceRuleId

void matchRuledSequenceRuleId(Id sequenceRuleId,
                            boolean match)

Matches enablers mapped to the sequence rule.

Parameters:

sequenceRuleId - the sequence rule Id

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

Throws:

NullArgumentException - sequenceRuleId is null

Compliance:

mandatory - This method must be implemented.

clearRuledSequenceRuleIdTerms

void clearRuledSequenceRuleIdTerms()

Clears the sequence rule Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledSequenceRuleQuery

boolean supportsRuledSequenceRuleQuery()

Tests if a SequenceRuleQuery is available.

Returns:

true if a sequence rule query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledSequenceRuleQuery

SequenceRuleQuery getRuledSequenceRuleQuery()

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

Returns:

the sequence rule query

Throws:

UnimplementedException - supportsRuledSequenceRuleQuery() is false

Compliance:

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

matchAnyRuledSequenceRule

void matchAnyRuledSequenceRule(boolean match)

Matches enablers mapped to any sequence rule.

Parameters:

match - true for enablers mapped to any sequence rule, false to match enablers mapped to no sequence rules

Compliance:

mandatory - This method must be implemented.

clearRuledSequenceRuleTerms

void clearRuledSequenceRuleTerms()

Clears the sequence rule query terms.

Compliance:

mandatory - This method must be implemented.

matchBankId

void matchBankId(Id bankId,
               boolean match)

Matches enablers mapped to the bank.

Parameters:

bankId - the bank Id

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

Throws:

NullArgumentException - bankId is null

Compliance:

mandatory - This method must be implemented.

clearBankIdTerms

void clearBankIdTerms()

Clears the bank Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBankQuery

boolean supportsBankQuery()

Tests if an BankQuery is available.

Returns:

true if a bank query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBankQuery

BankQuery getBankQuery()

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

Returns:

the bank query

Throws:

UnimplementedException - supportsBankQuery() is false

Compliance:

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

clearBankTerms

void clearBankTerms()

Clears the bank query terms.

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablerQueryRecord

SequenceRuleEnablerQueryRecord getSequenceRuleEnablerQueryRecord(Type sequenceRuleEnablerRecordType)
                                                                 throws OperationFailedException

Gets the sequence rule enabler query record corresponding to the given SequenceRuleEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

sequenceRuleEnablerRecordType - a sequence rule enabler record type

Returns:

the sequence rule enabler query record

Throws:

NullArgumentException - sequenceRuleEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sequenceRuleEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.