org.osid.commenting

Interface CommentQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface CommentQueryInspector
extends OsidRelationshipQueryInspector

The comment query inspector for examining comment queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getBookIdTerms() Gets the book Id terms.
BookQueryInspector[]	getBookTerms() Gets the book terms.
IdTerm[]	getCommentingAgentIdTerms() Gets the agent Id terms.
AgentQueryInspector[]	getCommentingAgentTerms() Gets the agent terms.
IdTerm[]	getCommentorIdTerms() Gets the resource Id terms.
ResourceQueryInspector[]	getCommentorTerms() Gets the resource terms.
CommentQueryInspectorRecord	getCommentQueryInspectorRecord(Type commentRecordType) Gets the comment query inspector record corresponding to the given Comment record Type.
IdTerm[]	getRatingIdTerms() Gets the rating Id terms.
GradeQueryInspector[]	getRatingTerms() Gets the rating terms.
IdTerm[]	getReferenceIdTerms() Gets the reference Id terms.
StringTerm[]	getTextTerms() Gets the text query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getReferenceIdTerms

IdTerm[] getReferenceIdTerms()

Gets the reference Id terms.

Returns:

the reference Id terms

Compliance:

mandatory - This method must be implemented.

getCommentorIdTerms

IdTerm[] getCommentorIdTerms()

Gets the resource Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getCommentorTerms

ResourceQueryInspector[] getCommentorTerms()

Gets the resource terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getCommentingAgentIdTerms

IdTerm[] getCommentingAgentIdTerms()

Gets the agent Id terms.

Returns:

the agent Id terms

Compliance:

mandatory - This method must be implemented.

getCommentingAgentTerms

AgentQueryInspector[] getCommentingAgentTerms()

Gets the agent terms.

Returns:

the agent terms

Compliance:

mandatory - This method must be implemented.

getTextTerms

StringTerm[] getTextTerms()

Gets the text query terms.

Returns:

the text query terms

Compliance:

mandatory - This method must be implemented.

getRatingIdTerms

IdTerm[] getRatingIdTerms()

Gets the rating Id terms.

Returns:

the rating Id terms

Compliance:

mandatory - This method must be implemented.

getRatingTerms

GradeQueryInspector[] getRatingTerms()

Gets the rating terms.

Returns:

the rating terms

Compliance:

mandatory - This method must be implemented.

getBookIdTerms

IdTerm[] getBookIdTerms()

Gets the book Id terms.

Returns:

the book Id terms

Compliance:

mandatory - This method must be implemented.

getBookTerms

BookQueryInspector[] getBookTerms()

Gets the book terms.

Returns:

the book terms

Compliance:

mandatory - This method must be implemented.

getCommentQueryInspectorRecord

CommentQueryInspectorRecord getCommentQueryInspectorRecord(Type commentRecordType)
                                                           throws OperationFailedException

Gets the comment query inspector record corresponding to the given Comment record Type.

Parameters:

commentRecordType - a comment record type

Returns:

the comment query inspector record

Throws:

NullArgumentException - commentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commentRecordType) is false

Compliance:

mandatory - This method must be implemented.