org.osid.filing

Interface FileQueryInspector

All Superinterfaces:

DirectoryEntryQueryInspector, Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface FileQueryInspector
extends DirectoryEntryQueryInspector

This is the query inspector for examining file queries.

Method Summary

Methods

Modifier and Type	Method and Description
StringTerm[]	getDataStringTerms() Gets the data string query terms.
BytesTerm[]	getDataTerms() Gets the data query terms.
FileQueryInspectorRecord	getFileQueryInspectorRecord(Type fileRecordType) Gets the file query inspector record corresponding to the given File record Type.
CardinalRangeTerm[]	getSizeTerms() Gets the size query terms.

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

getSizeTerms

CardinalRangeTerm[] getSizeTerms()

Gets the size query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDataStringTerms

StringTerm[] getDataStringTerms()

Gets the data string query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDataTerms

BytesTerm[] getDataTerms()

Gets the data query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFileQueryInspectorRecord

FileQueryInspectorRecord getFileQueryInspectorRecord(Type fileRecordType)
                                                     throws OperationFailedException

Gets the file query inspector record corresponding to the given File record Type.

Parameters:

fileRecordType - a file record type

Returns:

the file query inspector record

Throws:

NullArgumentException - fileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fileRecordType) is false

Compliance:

mandatory - This method must be implemented.