org.osid.calendaring.rules

Interface CommitmentEnablerQuery

All Superinterfaces:

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

public interface CommitmentEnablerQuery
extends OsidEnablerQuery

This is the query for searching commitment 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	clearCalendarIdTerms() Clears the calendar Id query terms.
void	clearCalendarTerms() Clears the calendar query terms.
void	clearRuledCommitmentIdTerms() Clears the commitment Id query terms.
void	clearRuledCommitmentTerms() Clears the commitment query terms.
CalendarQuery	getCalendarQuery() Gets the query for an calendar.
CommitmentEnablerQueryRecord	getCommitmentEnablerQueryRecord(Type commitmentEnablerRecordType) Gets the commitment enabler query record corresponding to the given CommitmentEnabler record Type.
CommitmentQuery	getRuledCommitmentQuery() Gets the query for a commitment.
void	matchAnyRuledCommitment(boolean match) Matches enablers mapped to any commitment.
void	matchCalendarId(Id calendarId, boolean match) Matches enablers mapped to the calendar.
void	matchRuledCommitmentId(Id commitmentId, boolean match) Matches enablers mapped to the commitment.
boolean	supportsCalendarQuery() Tests if an CalendarQuery is available.
boolean	supportsRuledCommitmentQuery() Tests if a CommitmentBookQuery 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

matchRuledCommitmentId

void matchRuledCommitmentId(Id commitmentId,
                          boolean match)

Matches enablers mapped to the commitment.

Parameters:

commitmentId - the commitment book Id

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

Throws:

NullArgumentException - commitmentBookId is null

Compliance:

mandatory - This method must be implemented.

clearRuledCommitmentIdTerms

void clearRuledCommitmentIdTerms()

Clears the commitment Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledCommitmentQuery

boolean supportsRuledCommitmentQuery()

Tests if a CommitmentBookQuery is available.

Returns:

true if a commitment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledCommitmentQuery

CommitmentQuery getRuledCommitmentQuery()

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

Returns:

the calendar query

Throws:

UnimplementedException - supportsCommitmentQuery() is false

Compliance:

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

matchAnyRuledCommitment

void matchAnyRuledCommitment(boolean match)

Matches enablers mapped to any commitment.

Parameters:

match - true for enablers mapped to any commitment, false to match enablers mapped to no commitment

Compliance:

mandatory - This method must be implemented.

clearRuledCommitmentTerms

void clearRuledCommitmentTerms()

Clears the commitment query terms.

Compliance:

mandatory - This method must be implemented.

matchCalendarId

void matchCalendarId(Id calendarId,
                   boolean match)

Matches enablers mapped to the calendar.

Parameters:

calendarId - the calendar Id

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

Throws:

NullArgumentException - calendarId is null

Compliance:

mandatory - This method must be implemented.

clearCalendarIdTerms

void clearCalendarIdTerms()

Clears the calendar Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCalendarQuery

boolean supportsCalendarQuery()

Tests if an CalendarQuery is available.

Returns:

true if an calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarQuery

CalendarQuery getCalendarQuery()

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

Returns:

the calendar query

Throws:

UnimplementedException - supportsCalendarQuery() is false

Compliance:

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

clearCalendarTerms

void clearCalendarTerms()

Clears the calendar query terms.

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerQueryRecord

CommitmentEnablerQueryRecord getCommitmentEnablerQueryRecord(Type commitmentEnablerRecordType)
                                                             throws OperationFailedException

Gets the commitment enabler query record corresponding to the given CommitmentEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

commitmentEnablerRecordType - a commitment enabler record type

Returns:

the commitment enabler query record

Throws:

NullArgumentException - commitmentEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.