org.osid.logging

Interface LogQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface LogQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining log queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorLogIdTerms() Gets the ancestor Id query terms.
LogQueryInspector[]	getAncestorLogTerms() Gets the ancestor query terms.
IdTerm[]	getDescendantLogIdTerms() Gets the descendant log Id query terms.
LogQueryInspector[]	getDescendantLogTerms() Gets the descendant log query terms.
IdTerm[]	getLogEntryIdTerms() Gets the log entry Id query terms.
LogEntryQueryInspector[]	getLogEntryTerms() Gets the log entry query terms.
LogQueryInspectorRecord	getLogQueryInspectorRecord(Type logRecordType) Gets the log query inspector record corresponding to the given Log record Type.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getLogEntryIdTerms

IdTerm[] getLogEntryIdTerms()

Gets the log entry Id query terms.

Returns:

the log entry Id terms

Compliance:

mandatory - This method must be implemented.

getLogEntryTerms

LogEntryQueryInspector[] getLogEntryTerms()

Gets the log entry query terms.

Returns:

the log entry terms

Compliance:

mandatory - This method must be implemented.

getAncestorLogIdTerms

IdTerm[] getAncestorLogIdTerms()

Gets the ancestor Id query terms.

Returns:

the ancestor Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorLogTerms

LogQueryInspector[] getAncestorLogTerms()

Gets the ancestor query terms.

Returns:

the ancestor terms

Compliance:

mandatory - This method must be implemented.

getDescendantLogIdTerms

IdTerm[] getDescendantLogIdTerms()

Gets the descendant log Id query terms.

Returns:

the descendant log Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantLogTerms

LogQueryInspector[] getDescendantLogTerms()

Gets the descendant log query terms.

Returns:

the descendant log terms

Compliance:

mandatory - This method must be implemented.

getLogQueryInspectorRecord

LogQueryInspectorRecord getLogQueryInspectorRecord(Type logRecordType)
                                                   throws OperationFailedException

Gets the log query inspector record corresponding to the given Log record Type.

Parameters:

logRecordType - a log record type

Returns:

the log query inspector record

Throws:

NullArgumentException - logRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logRecordType) is false

Compliance:

mandatory - This method must be implemented.