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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

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

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Methods inherited from interface OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Modifier and Type	Method	Description
IdTerm[]	getBrandingIdTerms()	Gets the asset Id query terms.
AssetQueryInspector[]	getBrandingTerms()	Gets the asset query terms.
StringTerm[]	getLicenseTerms()	Gets the license query terms.
IdTerm[]	getProviderIdTerms()	Gets the provider Id query terms.
ResourceQueryInspector[]	getProviderTerms()	Gets the provider query terms.

Method Details

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.