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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledAvailabilityId(Id availabilityId, boolean match)
availabilityId
- the availability Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- availabilityId
is null
mandatory
- This method must be implemented. void clearRuledAvailabilityIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAvailabilityQuery()
AvailabilityQuery
is available. true
if an availability query is available,
false
otherwisemandatory
- This method must be implemented. AvailabilityQuery getRuledAvailabilityQuery()
OR
term.UnimplementedException
-
supportsRuledAvailabilityQuery()
is false
optional
- This method must be implemented if
supportsRuledAvailabilityQuery()
is true.
void matchAnyRuledAvailability(boolean match)
match
- true
for mapped to any availability,
false
to match mapped to no availabilitiesmandatory
- This method must be implemented. void clearRuledAvailabilityTerms()
mandatory
- This method must be implemented. void matchFoundryId(Id foundryId, boolean match)
foundryId
- the foundry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearFoundryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFoundryQuery()
FoundryQuery
is available. true
if a foundry query is available,
false
otherwisemandatory
- This method must be implemented. FoundryQuery getFoundryQuery()
OR
term.UnimplementedException
- supportsFoundryQuery()
is false
optional
- This method must be implemented if
supportsFoundryQuery()
is true.
void clearFoundryTerms()
mandatory
- This method must be implemented. AvailabilityEnablerQueryRecord getAvailabilityEnablerQueryRecord(Type availabilityEnablerRecordType) throws OperationFailedException
AvailabilityEnabler
record Type.
Multiple record retrievals produce a nested OR
term.availabilityEnablerRecordType
- an availability enabler record
typeNullArgumentException
-
availabilityEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(availabilityEnablerRecordType)
is
false
mandatory
- This method must be implemented.