org.osid.forum

Interface PostQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface PostQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining for post queries. 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
IdTerm[]	getForumIdTerms() Gets the forum Id terms.
ForumQueryInspector[]	getForumTerms() Gets the forum terms.
IdTerm[]	getPosterIdTerms() Gets the poster Id terms.
ResourceQueryInspector[]	getPosterTerms() Gets the poster terms.
IdTerm[]	getPostingAgentIdTerms() Gets the poster Id terms.
AgentQueryInspector[]	getPostingAgentTerms() Gets the poster terms.
PostQueryInspectorRecord	getPostQueryInspectorRecord(Type postRecordType) Gets the query inspector record corresponding to the given Post record Type.
IdTerm[]	getReplyIdTerms() Gets the reply Id terms.
ReplyQueryInspector[]	getReplyTerms() Gets the reply terms.
StringTerm[]	getSubjectLineTerms() Gets the subject line terms.
StringTerm[]	getTextTerms() Gets the text terms.
DateTimeTerm[]	getTimestampTerms() Gets the timestamp 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

getTimestampTerms

DateTimeTerm[] getTimestampTerms()

Gets the timestamp terms.

Returns:

the timestamp terms

Compliance:

mandatory - This method must be implemented.

getPosterIdTerms

IdTerm[] getPosterIdTerms()

Gets the poster Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getPosterTerms

ResourceQueryInspector[] getPosterTerms()

Gets the poster terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPostingAgentIdTerms

IdTerm[] getPostingAgentIdTerms()

Gets the poster Id terms.

Returns:

the agent Id terms

Compliance:

mandatory - This method must be implemented.

getPostingAgentTerms

AgentQueryInspector[] getPostingAgentTerms()

Gets the poster terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubjectLineTerms

StringTerm[] getSubjectLineTerms()

Gets the subject line terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTextTerms

StringTerm[] getTextTerms()

Gets the text terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReplyIdTerms

IdTerm[] getReplyIdTerms()

Gets the reply Id terms.

Returns:

the reply Id terms

Compliance:

mandatory - This method must be implemented.

getReplyTerms

ReplyQueryInspector[] getReplyTerms()

Gets the reply terms.

Returns:

the reply terms

Compliance:

mandatory - This method must be implemented.

getForumIdTerms

IdTerm[] getForumIdTerms()

Gets the forum Id terms.

Returns:

the forum Id terms

Compliance:

mandatory - This method must be implemented.

getForumTerms

ForumQueryInspector[] getForumTerms()

Gets the forum terms.

Returns:

the forum terms

Compliance:

mandatory - This method must be implemented.

getPostQueryInspectorRecord

PostQueryInspectorRecord getPostQueryInspectorRecord(Type postRecordType)
                                                     throws OperationFailedException

Gets the query inspector record corresponding to the given Post record Type.

Parameters:

postRecordType - a post record type

Returns:

the post query inspector record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.