org.osid.filing

Interface DirectoryEntryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

All Known Subinterfaces:

DirectoryQuery, FileQuery

public interface DirectoryEntryQuery
extends OsidObjectQuery

DirectoryEntryQuery defines methods in common to both FileQuery and DirectoryQuery.

Method Summary

Methods

Modifier and Type	Method and 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(java.lang.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(java.lang.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 org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchName

void matchName(java.lang.String name,
             Type stringMatchType,
             boolean match)

Matches entry names. Supplying multiple strings behaves like a boolean AND among the elements each which must correspond to the stringMatchType. An OR can be performed with multiple queries.

Parameters:

name - name to match

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.

clearNameTerms

void clearNameTerms()

Clears the name terms.

Compliance:

mandatory - This method must be implemented.

matchPath

void matchPath(java.lang.String path,
             Type stringMatchType,
             boolean match)

Matches an absolute pathname of a directory entry. Supplying multiple strings behaves like a boolean AND among the elements each which must correspond to the stringMatchType. An OR can be performed with multiple queries.

Parameters:

path - path to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - name not of stringMatchType

NullArgumentException - path or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

clearPathTerms

void clearPathTerms()

Clears the path terms.

Compliance:

mandatory - This method must be implemented.

supportsDirectoryQuery

boolean supportsDirectoryQuery()

Tests if a DirectoryQuery is available.

Returns:

true if a directory query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDirectoryQuery

DirectoryQuery getDirectoryQuery()

Gets the query for a directory to match the parent directory. There is only one DirectoryQuery per DifrectoryEntryQuery. Multiple retrievals return the same object.

Returns:

the directory query

Throws:

UnimplementedException - supportsDirectoryQuery() is false

Compliance:

optional - This method must be implemented if supportsDirectoryQuery() is true.

clearDirectoryTerms

void clearDirectoryTerms()

Clears the directory terms.

Compliance:

mandatory - This method must be implemented.

matchAliases

void matchAliases(boolean match)

Matches aliases only.

Parameters:

match - true to match aliases, false to match target files

Compliance:

mandatory - This method must be implemented.

matchAnyAliases

void matchAnyAliases(boolean match)

Matches a file that has any aliases.

Parameters:

match - true to match any alias, false to match objects with no aliases

Compliance:

mandatory - This method must be implemented.

clearAliasesTerms

void clearAliasesTerms()

Clears the aliases terms.

Compliance:

mandatory - This method must be implemented.

matchOwnerId

void matchOwnerId(Id agentId,
                boolean match)

Matches files whose entries are owned by the given agent id.

Parameters:

agentId - the agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearOwnerIdTerms

void clearOwnerIdTerms()

Clears the owner Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOwnerQuery

boolean supportsOwnerQuery()

Tests if an AgentQuery is available for querying agents.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOwnerQuery

AgentQuery getOwnerQuery()

Gets the query for an agent.

Returns:

the agent query

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if supportsAgentQuery() is true.

clearOwnerTerms

void clearOwnerTerms()

Clears the owner terms.

Compliance:

mandatory - This method must be implemented.

matchCreatedTime

void matchCreatedTime(DateTime start,
                    DateTime end,
                    boolean match)

Match directory entries that are created between the specified time period inclusive.

Parameters:

start - start time of the query

end - end time of the query

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

Throws:

InvalidArgumentException - end is les than start

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

clearCreatedTimeTerms

void clearCreatedTimeTerms()

Clears the created time terms.

Compliance:

mandatory - This method must be implemented.

matchModifiedTime

void matchModifiedTime(DateTime start,
                     DateTime end,
                     boolean match)

Match directory entries that are modified between the specified time period inclusive.

Parameters:

start - start time of the query

end - end time of the query

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

Throws:

InvalidArgumentException - end is les than start

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

clearModifiedTimeTerms

void clearModifiedTimeTerms()

Clears the modified time terms.

Compliance:

mandatory - This method must be implemented.

matchLastAccessTime

void matchLastAccessTime(DateTime start,
                       DateTime end,
                       boolean match)

Match directory entries that were last accessed between the specified time period.

Parameters:

start - start time of the query

end - end time of the query

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

Throws:

InvalidArgumentException - end is les than start

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

clearLastAccessTimeTerms

void clearLastAccessTimeTerms()

Clears the last access time terms.

Compliance:

mandatory - This method must be implemented.