org.osid.repository.rules

Interface CompositionEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface CompositionEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining composition enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
CompositionEnablerQueryInspectorRecord	getCompositionEnablerQueryInspectorRecord(Type compositionEnablerRecordType) Gets the composition enabler query inspector record corresponding to the given CompositionEnabler record Type.
IdTerm[]	getRepositoryIdTerms() Gets the repository Id query terms.
RepositoryQueryInspector[]	getRepositoryTerms() Gets the repository query terms.
IdTerm[]	getRuledCompositionIdTerms() Gets the composition Id query terms.
CompositionQueryInspector[]	getRuledCompositionTerms() Gets the composition query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledCompositionIdTerms

IdTerm[] getRuledCompositionIdTerms()

Gets the composition Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledCompositionTerms

CompositionQueryInspector[] getRuledCompositionTerms()

Gets the composition query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRepositoryIdTerms

IdTerm[] getRepositoryIdTerms()

Gets the repository Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRepositoryTerms

RepositoryQueryInspector[] getRepositoryTerms()

Gets the repository query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQueryInspectorRecord

CompositionEnablerQueryInspectorRecord getCompositionEnablerQueryInspectorRecord(Type compositionEnablerRecordType)
                                                                                 throws OperationFailedException

Gets the composition enabler query inspector record corresponding to the given CompositionEnabler record Type.

Parameters:

compositionEnablerRecordType - a composition enabler record type

Returns:

the composition enabler query inspector record

Throws:

NullArgumentException - compositionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.