OSID - osid.logging.LogQuery Service Interface Definition

Interface	osid.logging.LogQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching for logs. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchLogEntryId
Description	Sets a log entry `Id.`
Parameters	`osid.id.Id`	`logEntryId`	a log entry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`logEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLogEntryIdTerms
Description	Clesrs the log entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLogEntryQuery
Description	Tests if a log entry query is available.
Return	`boolean`		`true` if a log entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryQuery
Description	Gets the query for a log entry.
Return	`osid.logging.LogEntryQuery`		the log entry query
Errors	UNIMPLEMENTED		`supportsLogEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryQuery()` is `true.`
Method	matchAnyLogEntry
Description	Matches logs with any log entry.
Parameters	`boolean`	`match`	`true` to match logs with any entry, `false` to match logs with no log entries
Compliance	`mandatory`		This method must be implemented.
Method	clearLogEntryTerms
Description	Clesrs the log entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorLogId
Description	Sets the log `Id` for this query to match logs that have the specified log as an ancestor.
Parameters	`osid.id.Id`	`logId`	a log `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`logId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorLogIdTerms
Description	Clesrs the ancestor log `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorLogQuery
Description	Tests if a `LogQuery` is available.
Return	`boolean`		`true` if a log query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorLogQuery
Description	Gets the query for a log. Multiple retrievals produce a nested `OR` term.
Return	`osid.logging.LogQuery`		the log query
Errors	UNIMPLEMENTED		`supportsAncestorLogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorLogQuery()` is `true.`
Method	matchAnyAncestorLog
Description	Matches logs with any ancestor.
Parameters	`boolean`	`match`	`true` to match logs with any ancestor, `false` to match root logs
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorLogTerms
Description	Clesrs the ancestor log terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantLogId
Description	Sets the log `Id` for this query to match logs that have the specified log as a descendant.
Parameters	`osid.id.Id`	`logId`	a log `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`logId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantLogIdTerms
Description	Clesrs the descendant log `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantLogQuery
Description	Tests if a `LogQuery` is available.
Return	`boolean`		`true` if a log query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantLogQuery
Description	Gets the query for a log. Multiple retrievals produce a nested `OR` term.
Return	`osid.logging.LogQuery`		the log query
Errors	UNIMPLEMENTED		`supportsDescendantLogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantLogQuery()` is `true.`
Method	matchAnyDescendantLog
Description	Matches logs with any descendant.
Parameters	`boolean`	`match`	`true` to match logs with any descendant, `false` to match leaf logs
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantLogTerms
Description	Clesrs the descendant log terms.
Compliance	`mandatory`		This method must be implemented.
Method	getLogQueryRecord
Description	Gets the log query record corresponding to the given `Log` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`logRecordType`	a log record type
Return	`osid.logging.records.LogQueryRecord`		the log query record
Errors	NULL_ARGUMENT		`logRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(logRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.