org.osid.repository

Interface CompositionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidContainableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface CompositionQueryInspector
extends OsidObjectQueryInspector, OsidContainableQueryInspector, OsidOperableQueryInspector, OsidSourceableQueryInspector

This is the query inspector for examining composition queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAssetIdTerms() Gets the asset Id query terms.
AssetQueryInspector[]	getAssetTerms() Gets the asset query terms.
CompositionQueryInspectorRecord	getCompositionQueryInspectorRecord(Type compositionRecordType) Gets the composition query inspector record corresponding to the given Composition record Type.
IdTerm[]	getContainedCompositionIdTerms() Gets the contained composition Id query terms.
CompositionQueryInspector[]	getContainedCompositionTerms() Gets the contained composition query terms.
IdTerm[]	getContainingCompositionIdTerms() Gets the containing composition Id query terms.
CompositionQueryInspector[]	getContainingCompositionTerms() Gets the containing composition query terms.
IdTerm[]	getRepositoryIdTerms() Gets the repository Id query terms.
RepositoryQueryInspector[]	getRepositoryTerms() Gets the repository query terms.

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.OsidContainableQueryInspector

getSequesteredTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getAssetIdTerms

IdTerm[] getAssetIdTerms()

Gets the asset Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAssetTerms

AssetQueryInspector[] getAssetTerms()

Gets the asset query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainingCompositionIdTerms

IdTerm[] getContainingCompositionIdTerms()

Gets the containing composition Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainingCompositionTerms

CompositionQueryInspector[] getContainingCompositionTerms()

Gets the containing composition query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainedCompositionIdTerms

IdTerm[] getContainedCompositionIdTerms()

Gets the contained composition Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainedCompositionTerms

CompositionQueryInspector[] getContainedCompositionTerms()

Gets the contained 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.

getCompositionQueryInspectorRecord

CompositionQueryInspectorRecord getCompositionQueryInspectorRecord(Type compositionRecordType)
                                                                   throws OperationFailedException

Gets the composition query inspector record corresponding to the given Composition record Type.

Parameters:

compositionRecordType - a composition record type

Returns:

the composition query inspector record

Throws:

NullArgumentException - compositionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionRecordType) is false

Compliance:

mandatory - This method must be implemented.