OSID - osid.logging.LogEntryQuery Service Interface Definition

Interface	osid.logging.LogEntryQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching log entries. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchPriority
Description	Matches a priority `Type` for the log entry.
Parameters	`osid.type.Type`	`priorityType`	`Type` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPriority
Description	Matches log entries with any priority.
Parameters	`boolean`	`match`	`true` to match log entries with any priority, `false` to match log entries with no priority
Compliance	`mandatory`		This method must be implemented.
Method	clearPriorityTerms
Description	Clears the priority terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumPriority
Description	Matches a log entries including and above the given priority type.
Parameters	`osid.type.Type`	`priorityType`	`Type` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumPriorityTerms
Description	Clears the minimum priority terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimestamp
Description	Matches the time of this log entry.
Parameters	`osid.calendaring.DateTime`	`startTime`	start time
	`osid.calendaring.DateTime`	`endTime`	end time
	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`startTime` is greater than `endTime`
Errors	NULL_ARGUMENT		`startTime` or `endTime` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestampTerms
Description	Clears the timestamp terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Matches a resource in this log entry.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available for querying agents.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAgentId
Description	Matches an agent in this log entry.
Parameters	`osid.id.Id`	`agentId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
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	getAgentQuery
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	clearAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLogId
Description	Matches a log.
Parameters	`osid.id.Id`	`logId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`logId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLogIdTerms
Description	Clears the log `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLogQuery
Description	Tests if a `LogQuery` is available for querying logs.
Return	`boolean`		`true` if a log query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLogQuery
Description	Gets the query for a log.
Return	`osid.logging.LogQuery`		the log query
Errors	UNIMPLEMENTED		`supportsLogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogQuery()` is `true.`
Method	clearLogTerms
Description	Clears the log terms.
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryQueryRecord
Description	Gets the log entry query corresponding to the given `LogEntry` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`logEntryRecordType`	a log entry record type
Return	`osid.logging.records.LogEntryQueryRecord`		the log entry query record
Errors	NULL_ARGUMENT		`logEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(logEutryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.