Interface DirectoryQuery

All Superinterfaces:

DirectoryEntryQuery, Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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);            
  

Method Summary

Modifier and Type	Method	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(String name, Type stringMatchType, boolean match)	Matches directories that contain the specified file name.
boolean	supportsFileQuery()	Tests if a FileQuery is available.

Methods inherited from interface DirectoryEntryQuery

clearAliasesTerms, clearCreatedTimeTerms, clearDirectoryTerms, clearLastAccessTimeTerms, clearModifiedTimeTerms, clearNameTerms, clearOwnerIdTerms, clearOwnerTerms, clearPathTerms, getDirectoryQuery, getOwnerQuery, matchAliases, matchAnyAliases, matchCreatedTime, matchLastAccessTime, matchModifiedTime, matchName, matchOwnerId, matchPath, supportsDirectoryQuery, supportsOwnerQuery

Modifier and Type	Method	Description
void	clearAliasesTerms()	Clears the aliases terms.
void	clearCreatedTimeTerms()	Clears the created time terms.
void	clearDirectoryTerms()	Clears the directory terms.
void	clearLastAccessTimeTerms()	Clears the last access time terms.
void	clearModifiedTimeTerms()	Clears the modified time terms.
void	clearNameTerms()	Clears the name terms.
void	clearOwnerIdTerms()	Clears the owner Id terms.
void	clearOwnerTerms()	Clears the owner terms.
void	clearPathTerms()	Clears the path terms.
DirectoryQuery	getDirectoryQuery()	Gets the query for a directory to match the parent directory.
AgentQuery	getOwnerQuery()	Gets the query for an agent.
void	matchAliases(boolean match)	Matches aliases only.
void	matchAnyAliases(boolean match)	Matches a file that has any aliases.
void	matchCreatedTime(DateTime start, DateTime end, boolean match)	Match directory entries that are created between the specified time period inclusive.
void	matchLastAccessTime(DateTime start, DateTime end, boolean match)	Match directory entries that were last accessed between the specified time period.
void	matchModifiedTime(DateTime start, DateTime end, boolean match)	Match directory entries that are modified between the specified time period inclusive.
void	matchName(String name, Type stringMatchType, boolean match)	Matches entry names.
void	matchOwnerId(Id agentId, boolean match)	Matches files whose entries are owned by the given agent id.
void	matchPath(String path, Type stringMatchType, boolean match)	Matches an absolute pathname of a directory entry.
boolean	supportsDirectoryQuery()	Tests if a DirectoryQuery is available.
boolean	supportsOwnerQuery()	Tests if an AgentQuery is available for querying agents.

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 OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchFileName

void matchFileName(String name,
 Type stringMatchType,
 boolean match)

Matches directories that contain the specified file name.

Parameters:

name - a file name

stringMatchType - the string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - name not of stringMatchType

NullArgumentException - name or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

clearFileNameTerms

void clearFileNameTerms()

Clears all file name terms.

Compliance:

mandatory - This method must be implemented.

supportsFileQuery

boolean supportsFileQuery()

Tests if a FileQuery is available.

Returns:

true if a file query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFileQuery

FileQuery getFileQuery(boolean match)

Gets the query for a file contained within the directory.

Parameters:

match - true for a positive match, false for a negative match

Returns:

the directory query

Throws:

UnimplementedException - supportsFileQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFileQuery()} is {@code true} .

matchAnyFile

void matchAnyFile(boolean match)

Matches directories with any file.

Parameters:

match - true to match directories with any file,, false to match directories with no file.

Compliance:

mandatory - This method must be implemented.

clearFileTerms

void clearFileTerms()

Clears all file terms.

Compliance:

mandatory - This method must be implemented.

getDirectoryQueryRecord

DirectoryQueryRecord getDirectoryQueryRecord(Type directoryRecordType)
                                      throws OperationFailedException

Gets the directory query record corresponding to the given Directory record Type . Multiple record retrievals produce a nested boolean OR term.

Parameters:

directoryRecordType - a directory record type

Returns:

the directory query record

Throws:

NullArgumentException - directoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directoryRecordType) is false

Compliance:

mandatory - This method must be implemented.