org.osid.repository.rules

Interface CompositionEnablerQuery

All Superinterfaces:

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

public interface CompositionEnablerQuery
extends OsidEnablerQuery

This is the query for searching composition 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	clearRepositoryIdTerms() Clears the repository Id query terms.
void	clearRepositoryTerms() Clears the repository query terms.
void	clearRuledCompositionIdTerms() Clears the composition Id query terms.
void	clearRuledCompositionTerms() Clears the composition query terms.
CompositionEnablerQueryRecord	getCompositionEnablerQueryRecord(Type compositionEnablerRecordType) Gets the composition enabler query record corresponding to the given CompositionEnabler record Type.
RepositoryQuery	getRepositoryQuery() Gets the query for a repository.
CompositionQuery	getRuledCompositionQuery() Gets the query for a composition.
void	matchAnyRuledComposition(boolean match) Matches enablers mapped to any composition.
void	matchRepositoryId(Id repositoryId, boolean match) Matches enablers mapped to the composition.
void	matchRuledCompositionId(Id compositionId, boolean match) Matches enablers mapped to the composition.
boolean	supportsRepositoryQuery() Tests if a RepositoryQuery is available.
boolean	supportsRuledCompositionQuery() Tests if a CompositionQuery 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

matchRuledCompositionId

void matchRuledCompositionId(Id compositionId,
                           boolean match)

Matches enablers mapped to the composition.

Parameters:

compositionId - the composition Id

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

Throws:

NullArgumentException - compositionId is null

Compliance:

mandatory - This method must be implemented.

clearRuledCompositionIdTerms

void clearRuledCompositionIdTerms()

Clears the composition Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledCompositionQuery

boolean supportsRuledCompositionQuery()

Tests if a CompositionQuery is available.

Returns:

true if a composition query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledCompositionQuery

CompositionQuery getRuledCompositionQuery()

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

Returns:

the composition query

Throws:

UnimplementedException - supportsRuledCompositionQuery() is false

Compliance:

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

matchAnyRuledComposition

void matchAnyRuledComposition(boolean match)

Matches enablers mapped to any composition.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledCompositionTerms

void clearRuledCompositionTerms()

Clears the composition query terms.

Compliance:

mandatory - This method must be implemented.

matchRepositoryId

void matchRepositoryId(Id repositoryId,
                     boolean match)

Matches enablers mapped to the composition.

Parameters:

repositoryId - the repository Id

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

Throws:

NullArgumentException - repositoryId is null

Compliance:

mandatory - This method must be implemented.

clearRepositoryIdTerms

void clearRepositoryIdTerms()

Clears the repository Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRepositoryQuery

boolean supportsRepositoryQuery()

Tests if a RepositoryQuery is available.

Returns:

true if a repository query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRepositoryQuery

RepositoryQuery getRepositoryQuery()

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

Returns:

the repository query

Throws:

UnimplementedException - supportsRepositoryQuery() is false

Compliance:

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

clearRepositoryTerms

void clearRepositoryTerms()

Clears the repository query terms.

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQueryRecord

CompositionEnablerQueryRecord getCompositionEnablerQueryRecord(Type compositionEnablerRecordType)
                                                               throws OperationFailedException

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

Parameters:

compositionEnablerRecordType - a composition enabler record type

Returns:

the composition enabler query record

Throws:

NullArgumentException - compositionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.