public interface HoldEnablerQuery extends OsidEnablerQuery
This is the query for searching hold enablers. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearOublietteIdTerms()
Clears the oubliette
Id query terms. |
void |
clearOublietteTerms()
Clears the oubliette query terms.
|
void |
clearRuledHoldIdTerms()
Clears the hold
Id query terms. |
void |
clearRuledHoldTerms()
Clears the hold query terms.
|
HoldEnablerQueryRecord |
getHoldEnablerQueryRecord(Type holdEnablerRecordType)
Gets the hold enabler query record corresponding to the given
HoldEnabler record Type. |
OublietteQuery |
getOublietteQuery()
Gets the query for an oubliette.
|
HoldQuery |
getRuledHoldQuery()
Gets the query for a hold.
|
void |
matchAnyRuledHold(boolean match)
Matches enablers mapped to any hold.
|
void |
matchOublietteId(Id oublietteId,
boolean match)
Matches enablers mapped to the oubliette.
|
void |
matchRuledHoldId(Id holdId,
boolean match)
Matches enablers mapped to the hold.
|
boolean |
supportsOublietteQuery()
Tests if a
OublietteQuery is available. |
boolean |
supportsRuledHoldQuery()
Tests if a
HoldQuery 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 matchRuledHoldId(Id holdId, boolean match)
holdId
- the hold Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- holdId
is
null
mandatory
- This method must be implemented. void clearRuledHoldIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledHoldQuery()
HoldQuery
is available. true
if a hold query is available, false
otherwisemandatory
- This method must be implemented. HoldQuery getRuledHoldQuery()
OR
term.UnimplementedException
-
supportsRuledHoldQuery()
is false
optional
- This method must be implemented if
supportsRuledHoldQuery()
is true.
void matchAnyRuledHold(boolean match)
match
- true
for enablers mapped to any hold,
false
to match enablers mapped to no holdmandatory
- This method must be implemented. void clearRuledHoldTerms()
mandatory
- This method must be implemented. void matchOublietteId(Id oublietteId, boolean match)
oublietteId
- the oubliette Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- oublietteId
is
null
mandatory
- This method must be implemented. void clearOublietteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsOublietteQuery()
OublietteQuery
is available. true
if an oubliette query is available,
false
otherwisemandatory
- This method must be implemented. OublietteQuery getOublietteQuery()
OR
term.UnimplementedException
-
supportsOublietteQuery()
is false
optional
- This method must be implemented if
supportsOublietteQuery()
is true.
void clearOublietteTerms()
mandatory
- This method must be implemented. HoldEnablerQueryRecord getHoldEnablerQueryRecord(Type holdEnablerRecordType) throws OperationFailedException
HoldEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.holdEnablerRecordType
- a hold enabler record typeNullArgumentException
- holdEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(holdEnablerRecordType)
is false
mandatory
- This method must be implemented.