org.osid.filing

Interface DirectoryQueryInspector

All Superinterfaces:

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

public interface DirectoryQueryInspector
extends OsidCatalogQueryInspector, DirectoryEntryQueryInspector

This is the query inspector for examining directory queries.

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryQueryInspectorRecord	getDirectoryQueryInspectorRecord(Type directoryRecordType) Gets the directory query inspector record corresponding to the given Directory record Type.
StringTerm[]	getFileNameTerms() Gets the file name query terms.
FileQueryInspector[]	getFileTerms() Gets the file query terms.

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Methods inherited from interface org.osid.filing.DirectoryEntryQueryInspector

getAliasesTerms, getCreatedTimeTerms, getDirectoryTerms, getLastAccessTimeTerms, getModifiedTimeTerms, getNameTerms, getOwnerIdTerms, getOwnerTerms, getPathTerms

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

Method Detail

getFileNameTerms

StringTerm[] getFileNameTerms()

Gets the file name query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFileTerms

FileQueryInspector[] getFileTerms()

Gets the file query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDirectoryQueryInspectorRecord

DirectoryQueryInspectorRecord getDirectoryQueryInspectorRecord(Type directoryRecordType)
                                                               throws OperationFailedException

Gets the directory query inspector record corresponding to the given Directory record Type.

Parameters:

directoryRecordType - a directory record type

Returns:

the directory query inspector record

Throws:

NullArgumentException - directoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directoryRecordType) is false

Compliance:

mandatory - This method must be implemented.