org.osid.tracking

Interface LogEntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface LogEntryQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examning log entry queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent query terms.
DateTimeRangeTerm[]	getDateTerms() Gets the date query terms.
IdTerm[]	getFrontOfficeIdTerms() Gets the front office Id query terms.
FrontOfficeQueryInspector[]	getFrontOfficeTerms() Gets the front office query terms.
IdTerm[]	getIssueIdTerms() Gets the issue Id query terms.
IssueQueryInspector[]	getIssueTerms() Gets the issue query terms.
LogEntryQueryInspectorRecord	getLogEntryQueryInspectorRecord(Type rlogEntryRecordType) Gets the log entry query inspector record corresponding to the given LogEntry record Type.
StringTerm[]	getMessageTerms() Gets the message query terms.
StringTerm[]	getSummaryTerms() Gets the summary query terms.

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

Method Detail

getAgentIdTerms

IdTerm[] getAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentTerms

AgentQueryInspector[] getAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIssueIdTerms

IdTerm[] getIssueIdTerms()

Gets the issue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIssueTerms

IssueQueryInspector[] getIssueTerms()

Gets the issue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDateTerms

DateTimeRangeTerm[] getDateTerms()

Gets the date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSummaryTerms

StringTerm[] getSummaryTerms()

Gets the summary query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMessageTerms

StringTerm[] getMessageTerms()

Gets the message query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdTerms

IdTerm[] getFrontOfficeIdTerms()

Gets the front office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFrontOfficeTerms

FrontOfficeQueryInspector[] getFrontOfficeTerms()

Gets the front office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLogEntryQueryInspectorRecord

LogEntryQueryInspectorRecord getLogEntryQueryInspectorRecord(Type rlogEntryRecordType)
                                                             throws OperationFailedException

Gets the log entry query inspector record corresponding to the given LogEntry record Type.

Parameters:

rlogEntryRecordType - a log entry record type

Returns:

the log entry query inspector record

Throws:

NullArgumentException - logEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.