org.osid.logging

Interface LogQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface LogQuery
extends OsidCatalogQuery

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 Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorLogIdTerms() Clesrs the ancestor log Id terms.
void	clearAncestorLogTerms() Clesrs the ancestor log terms.
void	clearDescendantLogIdTerms() Clesrs the descendant log Id terms.
void	clearDescendantLogTerms() Clesrs the descendant log terms.
void	clearLogEntryIdTerms() Clesrs the log entry Id terms.
void	clearLogEntryTerms() Clesrs the log entry terms.
LogQuery	getAncestorLogQuery() Gets the query for a log.
LogQuery	getDescendantLogQuery() Gets the query for a log.
LogEntryQuery	getLogEntryQuery() Gets the query for a log entry.
LogQueryRecord	getLogQueryRecord(Type logRecordType) Gets the log query record corresponding to the given Log record Type.
void	matchAncestorLogId(Id logId, boolean match) Sets the log Id for this query to match logs that have the specified log as an ancestor.
void	matchAnyAncestorLog(boolean match) Matches logs with any ancestor.
void	matchAnyDescendantLog(boolean match) Matches logs with any descendant.
void	matchAnyLogEntry(boolean match) Matches logs with any log entry.
void	matchDescendantLogId(Id logId, boolean match) Sets the log Id for this query to match logs that have the specified log as a descendant.
void	matchLogEntryId(Id logEntryId, boolean match) Sets a log entry Id.
boolean	supportsAncestorLogQuery() Tests if a LogQuery is available.
boolean	supportsDescendantLogQuery() Tests if a LogQuery is available.
boolean	supportsLogEntryQuery() Tests if a log entry query is available.

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchLogEntryId

void matchLogEntryId(Id logEntryId,
                   boolean match)

Sets a log entry Id.

Parameters:

logEntryId - a log entry Id

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

Throws:

NullArgumentException - logEntryId is null

Compliance:

mandatory - This method must be implemented.

clearLogEntryIdTerms

void clearLogEntryIdTerms()

Clesrs the log entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLogEntryQuery

boolean supportsLogEntryQuery()

Tests if a log entry query is available.

Returns:

true if a log entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLogEntryQuery

LogEntryQuery getLogEntryQuery()

Gets the query for a log entry.

Returns:

the log entry query

Throws:

UnimplementedException - supportsLogEntryQuery() is false

Compliance:

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

matchAnyLogEntry

void matchAnyLogEntry(boolean match)

Matches logs with any log entry.

Parameters:

match - true to match logs with any entry, false to match logs with no log entries

Compliance:

mandatory - This method must be implemented.

clearLogEntryTerms

void clearLogEntryTerms()

Clesrs the log entry terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorLogId

void matchAncestorLogId(Id logId,
                      boolean match)

Sets the log Id for this query to match logs that have the specified log as an ancestor.

Parameters:

logId - a log Id

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

Throws:

NullArgumentException - logId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorLogIdTerms

void clearAncestorLogIdTerms()

Clesrs the ancestor log Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorLogQuery

boolean supportsAncestorLogQuery()

Tests if a LogQuery is available.

Returns:

true if a log query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorLogQuery

LogQuery getAncestorLogQuery()

Gets the query for a log. Multiple retrievals produce a nested OR term.

Returns:

the log query

Throws:

UnimplementedException - supportsAncestorLogQuery() is false

Compliance:

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

matchAnyAncestorLog

void matchAnyAncestorLog(boolean match)

Matches logs with any ancestor.

Parameters:

match - true to match logs with any ancestor, false to match root logs

Compliance:

mandatory - This method must be implemented.

clearAncestorLogTerms

void clearAncestorLogTerms()

Clesrs the ancestor log terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantLogId

void matchDescendantLogId(Id logId,
                        boolean match)

Sets the log Id for this query to match logs that have the specified log as a descendant.

Parameters:

logId - a log Id

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

Throws:

NullArgumentException - logId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantLogIdTerms

void clearDescendantLogIdTerms()

Clesrs the descendant log Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantLogQuery

boolean supportsDescendantLogQuery()

Tests if a LogQuery is available.

Returns:

true if a log query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantLogQuery

LogQuery getDescendantLogQuery()

Gets the query for a log. Multiple retrievals produce a nested OR term.

Returns:

the log query

Throws:

UnimplementedException - supportsDescendantLogQuery() is false

Compliance:

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

matchAnyDescendantLog

void matchAnyDescendantLog(boolean match)

Matches logs with any descendant.

Parameters:

match - true to match logs with any descendant, false to match leaf logs

Compliance:

mandatory - This method must be implemented.

clearDescendantLogTerms

void clearDescendantLogTerms()

Clesrs the descendant log terms.

Compliance:

mandatory - This method must be implemented.

getLogQueryRecord

LogQueryRecord getLogQueryRecord(Type logRecordType)
                                 throws OperationFailedException

Gets the log query record corresponding to the given Log record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

logRecordType - a log record type

Returns:

the log query record

Throws:

NullArgumentException - logRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logRecordType) is false

Compliance:

mandatory - This method must be implemented.