org.osid.offering.rules

Interface CanonicalUnitProcessorQueryInspector

All Superinterfaces:

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

public interface CanonicalUnitProcessorQueryInspector
extends OsidProcessorQueryInspector

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

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitProcessorQueryInspectorRecord	getCanonicalUnitProcessorQueryInspectorRecord(Type canonicalUnitProcessorRecordType) Gets the canonical unit processor query inspector record corresponding to the given CanonicalUnitProcessor record Type.
IdTerm[]	getCatalogueIdTerms() Gets the catalogue Id query terms.
CatalogueQueryInspector[]	getCatalogueTerms() Gets the catalogue 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.

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.

getCanonicalUnitProcessorQueryInspectorRecord

CanonicalUnitProcessorQueryInspectorRecord getCanonicalUnitProcessorQueryInspectorRecord(Type canonicalUnitProcessorRecordType)
                                                                                         throws OperationFailedException

Gets the canonical unit processor query inspector record corresponding to the given CanonicalUnitProcessor record Type.

Parameters:

canonicalUnitProcessorRecordType - a canonical unit processor record type

Returns:

the canonical unit processor query inspector record

Throws:

NullArgumentException - canonicalUnitProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.