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

Modifier and Type	Method	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 DirectoryEntryQueryInspector

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

Modifier and Type	Method	Description
BooleanTerm[]	getAliasesTerms()	Gets the aliases query terms.
DateTimeRangeTerm[]	getCreatedTimeTerms()	Gets the created time query terms.
DirectoryQueryInspector[]	getDirectoryTerms()	Gets the directory query terms.
DateTimeRangeTerm[]	getLastAccessTimeTerms()	Gets the last access time query terms.
DateTimeRangeTerm[]	getModifiedTimeTerms()	Gets the modified time query terms.
StringTerm[]	getNameTerms()	Gets the name query terms.
IdTerm[]	getOwnerIdTerms()	Gets the owner Id query terms.
AgentQueryInspector[]	getOwnerTerms()	Gets the owner query terms.
StringTerm[]	getPathTerms()	Gets the path query terms.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Method Details

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.