org.osid.cataloging.rules

Interface CatalogEnablerQuery

All Superinterfaces:

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

public interface CatalogEnablerQuery
extends OsidEnablerQuery

This is the query for searching catalog 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	clearCatalogIdTerms() Clears the catalog Id query terms.
void	clearCatalogTerms() Clears the catalog query terms.
void	clearRuledCatalogIdTerms() Clears the catalog Id query terms.
void	clearRuledCatalogTerms() Clears the catalog query terms.
CatalogEnablerQueryRecord	getCatalogEnablerQueryRecord(Type catalogEnablerRecordType) Gets the catalog enabler query record corresponding to the given CatalogEnabler record Type.
CatalogQuery	getCatalogQuery() Gets the query for a catalog.
CatalogQuery	getRuledCatalogQuery() Gets the query for a catalog.
void	matchAnyRuledCatalog(boolean match) Matches enablers mapped to any catalog.
void	matchCatalogId(Id catalogId, boolean match) Matches enablers mapped to the catalog.
void	matchRuledCatalogId(Id catalogId, boolean match) Matches enablers mapped to the catalog.
boolean	supportsCatalogQuery() Tests if a CatalogQuery is available.
boolean	supportsRuledCatalogQuery() Tests if a CatalogQuery 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

matchRuledCatalogId

void matchRuledCatalogId(Id catalogId,
                       boolean match)

Matches enablers mapped to the catalog.

Parameters:

catalogId - the catalog Id

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

Throws:

NullArgumentException - catalogId is null

Compliance:

mandatory - This method must be implemented.

clearRuledCatalogIdTerms

void clearRuledCatalogIdTerms()

Clears the catalog Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledCatalogQuery

boolean supportsRuledCatalogQuery()

Tests if a CatalogQuery is available.

Returns:

true if a catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledCatalogQuery

CatalogQuery getRuledCatalogQuery()

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

Returns:

the catalog query

Throws:

UnimplementedException - supportsRuledCatalogQuery() is false

Compliance:

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

matchAnyRuledCatalog

void matchAnyRuledCatalog(boolean match)

Matches enablers mapped to any catalog.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledCatalogTerms

void clearRuledCatalogTerms()

Clears the catalog query terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogId

void matchCatalogId(Id catalogId,
                  boolean match)

Matches enablers mapped to the catalog.

Parameters:

catalogId - the catalog Id

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

Throws:

NullArgumentException - catalogId is null

Compliance:

mandatory - This method must be implemented.

clearCatalogIdTerms

void clearCatalogIdTerms()

Clears the catalog Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCatalogQuery

boolean supportsCatalogQuery()

Tests if a CatalogQuery is available.

Returns:

true if a catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogQuery

CatalogQuery getCatalogQuery()

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

Returns:

the catalog query

Throws:

UnimplementedException - supportsCatalogQuery() is false

Compliance:

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

clearCatalogTerms

void clearCatalogTerms()

Clears the catalog query terms.

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerQueryRecord

CatalogEnablerQueryRecord getCatalogEnablerQueryRecord(Type catalogEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

catalogEnablerRecordType - a catalog enabler record type

Returns:

the catalog enabler query record

Throws:

NullArgumentException - catalogEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.