OSID - osid.tracking.LogEntryQuery Service Interface Definition

Interface	osid.tracking.LogEntryQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching log entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchAgentId
Description	Sets the agent `Id` for this query.
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	clearAgentIdTerms
Description	Clears the agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available.
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. Multiple retrievals produce a nested `OR` term.
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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIssueId
Description	Sets the issue `Id` for this query.
Parameters	`osid.id.Id`	`issueId`	the issue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIssueIdTerms
Description	Clears the issue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueQuery
Description	Tests if an `IssueQuery` is available for an ending issue.
Return	`boolean`		`true` if an issue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQuery
Description	Gets the query for an issue. Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.IssueQuery`		the issue query
Errors	UNIMPLEMENTED		`supportsIssueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIssueQuery()` is `true.`
Method	clearIssueTerms
Description	Clears the issue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches log entries that have the specified date inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting range
	`osid.calendaring.DateTime`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSummary
Description	Matches a summary.
Parameters	`string`	`summary`	summary
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`summary` not of `stringMatchType`
	NULL_ARGUMENT		`summary` or `stringMatchType` is `null`
	UNSUPPORTED		`stringMatchType` not supported
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySummary
Description	Matches log entries that has any summary.
Parameters	`boolean`	`match`	`true` to match log entries with any summary, `false` to match log entries with no summary
Compliance	`mandatory`		This method must be implemented.
Method	clearSummaryTerms
Description	Clears the summary query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMessage
Description	Matches a message.
Parameters	`string`	`message`	a message
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`message` not of `stringMatchType`
	NULL_ARGUMENT		`message` or `stringMatchType` is `null`
	UNSUPPORTED		`stringMatchType` not supported
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMessage
Description	Matches log entries that has any message.
Parameters	`boolean`	`match`	`true` to match log entries with any message, `false` to match log entries with no message
Compliance	`mandatory`		This method must be implemented.
Method	clearMessageTerms
Description	Clears the message query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFrontOfficeId
Description	Sets the front office `Id` for this query to match log entries assigned to front offices.
Parameters	`osid.id.Id`	`frontOfficeId`	the front office `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`frontOfficeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFrontOfficeIdTerms
Description	Clears the front office `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeQuery
Description	Tests if a `FrontOfficeQuery` is available.
Return	`boolean`		`true` if a front office query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeQuery
Description	Gets the query for a front office. Multiple retrievals produce a nested `OR` term.
Return	`osid.tracking.FrontOfficeQuery`		the front office query
Errors	UNIMPLEMENTED		`supportsFrontOfficeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFrontOfficeQuery()` is `true.`
Method	clearFrontOfficeTerms
Description	Clears the front office query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryQueryRecord
Description	Gets the log entry query record corresponding to the given `LogEntry` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`logEntryRecordType`	an log entry record type
Return	`osid.tracking.records.LogEntryQueryRecord`		the log entry query record
Errors	NULL_ARGUMENT		`logEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(logEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.