org.osid.resourcing.rules

Interface AvailabilityEnablerQuery

All Superinterfaces:

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

public interface AvailabilityEnablerQuery
extends OsidEnablerQuery

This is the query for searching availability 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	clearFoundryIdTerms() Clears the foundry Id query terms.
void	clearFoundryTerms() Clears the foundry query terms.
void	clearRuledAvailabilityIdTerms() Clears the availability Id query terms.
void	clearRuledAvailabilityTerms() Clears the availability query terms.
AvailabilityEnablerQueryRecord	getAvailabilityEnablerQueryRecord(Type availabilityEnablerRecordType) Gets the availability enabler query record corresponding to the given AvailabilityEnabler record Type.
FoundryQuery	getFoundryQuery() Gets the query for a foundry.
AvailabilityQuery	getRuledAvailabilityQuery() Gets the query for an availability.
void	matchAnyRuledAvailability(boolean match) Matches mapped to any availability.
void	matchFoundryId(Id foundryId, boolean match) Matches mapped to the foundry.
void	matchRuledAvailabilityId(Id availabilityId, boolean match) Matches mapped to an availability.
boolean	supportsFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsRuledAvailabilityQuery() Tests if an AvailabilityQuery 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

matchRuledAvailabilityId

void matchRuledAvailabilityId(Id availabilityId,
                            boolean match)

Matches mapped to an availability.

Parameters:

availabilityId - the availability Id

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

Throws:

NullArgumentException - availabilityId is null

Compliance:

mandatory - This method must be implemented.

clearRuledAvailabilityIdTerms

void clearRuledAvailabilityIdTerms()

Clears the availability Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAvailabilityQuery

boolean supportsRuledAvailabilityQuery()

Tests if an AvailabilityQuery is available.

Returns:

true if an availability query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAvailabilityQuery

AvailabilityQuery getRuledAvailabilityQuery()

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

Returns:

the availability query

Throws:

UnimplementedException - supportsRuledAvailabilityQuery() is false

Compliance:

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

matchAnyRuledAvailability

void matchAnyRuledAvailability(boolean match)

Matches mapped to any availability.

Parameters:

match - true for mapped to any availability, false to match mapped to no availabilities

Compliance:

mandatory - This method must be implemented.

clearRuledAvailabilityTerms

void clearRuledAvailabilityTerms()

Clears the availability query terms.

Compliance:

mandatory - This method must be implemented.

matchFoundryId

void matchFoundryId(Id foundryId,
                  boolean match)

Matches mapped to the foundry.

Parameters:

foundryId - the foundry Id

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

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

clearFoundryIdTerms

void clearFoundryIdTerms()

Clears the foundry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFoundryQuery

boolean supportsFoundryQuery()

Tests if a FoundryQuery is available.

Returns:

true if a foundry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFoundryQuery

FoundryQuery getFoundryQuery()

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

Returns:

the foundry query

Throws:

UnimplementedException - supportsFoundryQuery() is false

Compliance:

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

clearFoundryTerms

void clearFoundryTerms()

Clears the foundry query terms.

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerQueryRecord

AvailabilityEnablerQueryRecord getAvailabilityEnablerQueryRecord(Type availabilityEnablerRecordType)
                                                                 throws OperationFailedException

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

Parameters:

availabilityEnablerRecordType - an availability enabler record type

Returns:

the availability enabler query record

Throws:

NullArgumentException - availabilityEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilityEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.