OSID - osid.filing.DirectoryEntryQuery Service Interface Definition

Interface	osid.filing.DirectoryEntryQuery
Implements	`osid.OsidObjectQuery`
Description	`DirectoryEntryQuery` defines methods in common to both `FileQuery` and `DirectoryQuery.`
Method	matchName
Description	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	`string`	`name`	name to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`name` not of `stringMatchType`
	NULL_ARGUMENT		`name` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearNameTerms
Description	Clears the name terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPath
Description	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	`string`	`path`	path to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`name` not of `stringMatchType`
	NULL_ARGUMENT		`path` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearPathTerms
Description	Clears the path terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectoryQuery
Description	Tests if a `DirectoryQuery` is available.
Return	`boolean`		`true` if a directory query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDirectoryQuery
Description	Gets the query for a directory to match the parent directory. There is only one `DirectoryQuery` per `DifrectoryEntryQuery.` Multiple retrievals return the same object.
Return	`osid.filing.DirectoryQuery`		the directory query
Errors	UNIMPLEMENTED		`supportsDirectoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryQuery()` is `true.`
Method	clearDirectoryTerms
Description	Clears the directory terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAliases
Description	Matches aliases only.
Parameters	`boolean`	`match`	`true` to match aliases, `false` to match target files
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAliases
Description	Matches a file that has any aliases.
Parameters	`boolean`	`match`	`true` to match any alias, `false` to match objects with no aliases
Compliance	`mandatory`		This method must be implemented.
Method	clearAliasesTerms
Description	Clears the aliases terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOwnerId
Description	Matches files whose entries are owned by the given agent id.
Parameters	`osid.id.Id`	`agentId`	the agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOwnerIdTerms
Description	Clears the owner `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOwnerQuery
Description	Tests if an `AgentQuery` is available for querying agents.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOwnerQuery
Description	Gets the query for an agent.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true.`
Method	clearOwnerTerms
Description	Clears the owner terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreatedTime
Description	Match directory entries that are created between the specified time period inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is les than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreatedTimeTerms
Description	Clears the created time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchModifiedTime
Description	Match directory entries that are modified between the specified time period inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is les than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearModifiedTimeTerms
Description	Clears the modified time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLastAccessTime
Description	Match directory entries that were last accessed between the specified time period.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is les than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLastAccessTimeTerms
Description	Clears the last access time terms.
Compliance	`mandatory`		This method must be implemented.