org.osid.hold.rules

Interface HoldEnablerQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

matchRuledHoldId

void matchRuledHoldId(Id holdId,
                    boolean match)

Matches enablers mapped to the hold.

Parameters:

holdId - the hold Id

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

Throws:

NullArgumentException - holdId is null

Compliance:

mandatory - This method must be implemented.

clearRuledHoldIdTerms

void clearRuledHoldIdTerms()

Clears the hold Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledHoldQuery

boolean supportsRuledHoldQuery()

Tests if a HoldQuery is available.

Returns:

true if a hold query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledHoldQuery

HoldQuery getRuledHoldQuery()

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

Returns:

the hold query

Throws:

UnimplementedException - supportsRuledHoldQuery() is false

Compliance:

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

matchAnyRuledHold

void matchAnyRuledHold(boolean match)

Matches enablers mapped to any hold.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledHoldTerms

void clearRuledHoldTerms()

Clears the hold query terms.

Compliance:

mandatory - This method must be implemented.

matchOublietteId

void matchOublietteId(Id oublietteId,
                    boolean match)

Matches enablers mapped to the oubliette.

Parameters:

oublietteId - the oubliette Id

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

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

clearOublietteIdTerms

void clearOublietteIdTerms()

Clears the oubliette Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOublietteQuery

boolean supportsOublietteQuery()

Tests if a OublietteQuery is available.

Returns:

true if an oubliette query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOublietteQuery

OublietteQuery getOublietteQuery()

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

Returns:

the oubliette query

Throws:

UnimplementedException - supportsOublietteQuery() is false

Compliance:

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

clearOublietteTerms

void clearOublietteTerms()

Clears the oubliette query terms.

Compliance:

mandatory - This method must be implemented.

getHoldEnablerQueryRecord

HoldEnablerQueryRecord getHoldEnablerQueryRecord(Type holdEnablerRecordType)
                                                 throws OperationFailedException

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

Parameters:

holdEnablerRecordType - a hold enabler record type

Returns:

the hold enabler query record

Throws:

NullArgumentException - holdEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(holdEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.