public interface DirectoryQuery extends OsidCatalogQuery, DirectoryEntryQuery
This is the query for searching directories. Each method match request
produces an AND
term while multiple invocations of a method
produces a nested OR.
An example to find directories whose name is "Library".
DirectoryQuery query = session.getDirectoryQuery(); query.matchName("Library", wordStringMatchType, true); DirectoryList list = session.getDirectoriesByQuery(query);
Modifier and Type | Method and Description |
---|---|
void |
clearFileNameTerms()
Clears all file name terms.
|
void |
clearFileTerms()
Clears all file terms.
|
DirectoryQueryRecord |
getDirectoryQueryRecord(Type directoryRecordType)
Gets the directory query record corresponding to the given
Directory record Type. |
FileQuery |
getFileQuery(boolean match)
Gets the query for a file contained within the directory.
|
void |
matchAnyFile(boolean match)
Matches directories with any file.
|
void |
matchFileName(java.lang.String name,
Type stringMatchType,
boolean match)
Matches directories that contain the specified file name.
|
boolean |
supportsFileQuery()
Tests if a
FileQuery is available. |
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
clearAliasesTerms, clearCreatedTimeTerms, clearDirectoryTerms, clearLastAccessTimeTerms, clearModifiedTimeTerms, clearNameTerms, clearOwnerIdTerms, clearOwnerTerms, clearPathTerms, getDirectoryQuery, getOwnerQuery, matchAliases, matchAnyAliases, matchCreatedTime, matchLastAccessTime, matchModifiedTime, matchName, matchOwnerId, matchPath, supportsDirectoryQuery, supportsOwnerQuery
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchFileName(java.lang.String name, Type stringMatchType, boolean match)
name
- a file namestringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- name
not of
stringMatchType
NullArgumentException
- name
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void clearFileNameTerms()
mandatory
- This method must be implemented. boolean supportsFileQuery()
FileQuery
is available. true
if a file query is available, false
otherwisemandatory
- This method must be implemented. FileQuery getFileQuery(boolean match)
match
- true
for a positive match, false
for a negative matchUnimplementedException
- supportsFileQuery()
is false
optional
- This method must be implemented if
supportsFileQuery()
is true.
void matchAnyFile(boolean match)
match
- true
to match directories with any file,,
false
to match directories with no file.mandatory
- This method must be implemented. void clearFileTerms()
mandatory
- This method must be implemented. DirectoryQueryRecord getDirectoryQueryRecord(Type directoryRecordType) throws OperationFailedException
Directory
record Type.
Multiple record
retrievals produce a nested boolean OR
term.directoryRecordType
- a directory record typeNullArgumentException
- directoryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(directoryRecordType)
is false
mandatory
- This method must be implemented.