org.osid.repository

Interface RepositoryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface RepositoryQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining repository queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorRepositoryIdTerms() Gets the ancestor repository Id query terms.
RepositoryQueryInspector[]	getAncestorRepositoryTerms() Gets the ancestor repository query terms.
IdTerm[]	getAssetIdTerms() Gets the asset Id query terms.
AssetQueryInspector[]	getAssetTerms() Gets the asset query terms.
IdTerm[]	getCompositionIdTerms() Gets the composition Id query terms.
CompositionQueryInspector[]	getCompositionTerms() Gets the composition query terms.
IdTerm[]	getDescendantRepositoryIdTerms() Gets the descendant repository Id query terms.
RepositoryQueryInspector[]	getDescendantRepositoryTerms() Gets the descendant repository query terms.
RepositoryQueryInspectorRecord	getRepositoryQueryInspectorRecord(Type repositoryRecordType) Gets the repository query inspector record corresponding to the given Repository record Type.

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

getCompositionIdTerms

IdTerm[] getCompositionIdTerms()

Gets the composition Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCompositionTerms

CompositionQueryInspector[] getCompositionTerms()

Gets the composition query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorRepositoryIdTerms

IdTerm[] getAncestorRepositoryIdTerms()

Gets the ancestor repository Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorRepositoryTerms

RepositoryQueryInspector[] getAncestorRepositoryTerms()

Gets the ancestor repository query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantRepositoryIdTerms

IdTerm[] getDescendantRepositoryIdTerms()

Gets the descendant repository Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantRepositoryTerms

RepositoryQueryInspector[] getDescendantRepositoryTerms()

Gets the descendant repository query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRepositoryQueryInspectorRecord

RepositoryQueryInspectorRecord getRepositoryQueryInspectorRecord(Type repositoryRecordType)
                                                                 throws OperationFailedException

Gets the repository query inspector record corresponding to the given Repository record Type.

Parameters:

repositoryRecordType - a repository record type

Returns:

the repository query inspector record

Throws:

NullArgumentException - repositoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(repositoryRecordType) is false

Compliance:

mandatory - This method must be implemented.