org.osid.offering.rules

Interface CanonicalUnitEnablerQueryInspector

All Superinterfaces:

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

public interface CanonicalUnitEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining canonical unit enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitEnablerQueryInspectorRecord	getCanonicalUnitEnablerQueryInspectorRecord(Type canonicalUnitEnablerRecordType) Gets the canonical unit enabler query inspector record corresponding to the given CanonicalUnitEnabler record Type.
IdTerm[]	getCatalogueIdTerms() Gets the catalogue Id query terms.
CatalogueQueryInspector[]	getCatalogueTerms() Gets the catalogue query terms.
IdTerm[]	getRuledOfferingConstrainerIdTerms() Gets the offering constrainer Id query terms.
OfferingConstrainerQueryInspector[]	getRuledOfferingConstrainerTerms() Gets the offering constrainer 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

getRuledOfferingConstrainerIdTerms

IdTerm[] getRuledOfferingConstrainerIdTerms()

Gets the offering constrainer Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledOfferingConstrainerTerms

OfferingConstrainerQueryInspector[] getRuledOfferingConstrainerTerms()

Gets the offering constrainer query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogueIdTerms

IdTerm[] getCatalogueIdTerms()

Gets the catalogue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogueTerms

CatalogueQueryInspector[] getCatalogueTerms()

Gets the catalogue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerQueryInspectorRecord

CanonicalUnitEnablerQueryInspectorRecord getCanonicalUnitEnablerQueryInspectorRecord(Type canonicalUnitEnablerRecordType)
                                                                                     throws OperationFailedException

Gets the canonical unit enabler query inspector record corresponding to the given CanonicalUnitEnabler record Type.

Parameters:

canonicalUnitEnablerRecordType - a canonical unit enabler record type

Returns:

the canonical unit enabler query inspector record

Throws:

NullArgumentException - canonicalUnitEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.