org.osid.offering.rules

Interface OfferingConstrainerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidConstrainerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface OfferingConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query inspector for examining offering constrainer queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCatalogueIdTerms() Gets the catalogue Id query terms.
CatalogueQueryInspector[]	getCatalogueTerms() Gets the catalogue query terms.
BooleanTerm[]	getConstrainResultOptionsTerms() Gets the constrain result options query terms.
BooleanTerm[]	getConstrainSponsorsTerms() Gets the constrain sponsors query terms.
BooleanTerm[]	getConstrainTimePeriodsTerms() Gets the override time periods query terms.
OfferingConstrainerQueryInspectorRecord	getOfferingConstrainerQueryInspectorRecord(Type offeringConstrainerRecordType) Gets the offering constrainer query inspector record corresponding to the given OfferingConstrainer record Type.
BooleanTerm[]	getOverrideCodeTerms() Gets the override code query terms.
BooleanTerm[]	getOverrideDescriptionTerms() Gets the override description query terms.
BooleanTerm[]	getOverrideResultOptionsTerms() Gets the override result options query terms.
BooleanTerm[]	getOverrideSponsorsTerms() Gets the override sponsors query terms.
BooleanTerm[]	getOverrideTimePeriodsTerms() Gets the override time periods query terms.
BooleanTerm[]	getOverrideTitleTerms() Gets the override title query terms.
IdTerm[]	getRuledCanonicalUnitIdTerms() Gets the canonical unit Id query terms.
CanonicalUnitQueryInspector[]	getRuledCanonicalUnitTerms() Gets the canonical unit query terms.

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

Method Detail

getRuledCanonicalUnitIdTerms

IdTerm[] getRuledCanonicalUnitIdTerms()

Gets the canonical unit Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledCanonicalUnitTerms

CanonicalUnitQueryInspector[] getRuledCanonicalUnitTerms()

Gets the canonical unit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideDescriptionTerms

BooleanTerm[] getOverrideDescriptionTerms()

Gets the override description query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideTitleTerms

BooleanTerm[] getOverrideTitleTerms()

Gets the override title query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideCodeTerms

BooleanTerm[] getOverrideCodeTerms()

Gets the override code query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideTimePeriodsTerms

BooleanTerm[] getOverrideTimePeriodsTerms()

Gets the override time periods query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConstrainTimePeriodsTerms

BooleanTerm[] getConstrainTimePeriodsTerms()

Gets the override time periods query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideResultOptionsTerms

BooleanTerm[] getOverrideResultOptionsTerms()

Gets the override result options query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConstrainResultOptionsTerms

BooleanTerm[] getConstrainResultOptionsTerms()

Gets the constrain result options query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverrideSponsorsTerms

BooleanTerm[] getOverrideSponsorsTerms()

Gets the override sponsors query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConstrainSponsorsTerms

BooleanTerm[] getConstrainSponsorsTerms()

Gets the constrain sponsors 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.

getOfferingConstrainerQueryInspectorRecord

OfferingConstrainerQueryInspectorRecord getOfferingConstrainerQueryInspectorRecord(Type offeringConstrainerRecordType)
                                                                                   throws OperationFailedException

Gets the offering constrainer query inspector record corresponding to the given OfferingConstrainer record Type.

Parameters:

offeringConstrainerRecordType - an offering constrainer record type

Returns:

the offering constrainer query inspector record

Throws:

NullArgumentException - offeringConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offeringConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.