Interface BranchQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector

public interface BranchQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector

This is the query inspector for examining branch queries.

Method Summary

Modifier and Type	Method	Description
BranchQueryInspectorRecord	getBranchQueryInspectorRecord(Type branchRecordType)	Gets the branch query inspector record corresponding to the given Branch record Type .
IdTerm[]	getLatestJournalEntryIdTerms()	Gets the latest journal entry Id query terms.
JournalEntryQueryInspector[]	getLatestJournalEntryTerms()	Gets the latest journal entry query terms.
IdTerm[]	getOriginJournalEntryIdTerms()	Gets the origin journal entry Id query terms.
JournalEntryQueryInspector[]	getOriginJournalEntryTerms()	Gets the origin journal entry query terms.

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 OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Modifier and Type	Method	Description
BooleanTerm[]	getActiveTerms()	Gets the active query terms.
BooleanTerm[]	getDisabledTerms()	Gets the administratively disabled query terms.
BooleanTerm[]	getEnabledTerms()	Gets the administratively enabled query terms.
BooleanTerm[]	getOperationalTerms()	Gets the operational 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.

Method Details

getOriginJournalEntryIdTerms

IdTerm[] getOriginJournalEntryIdTerms()

Gets the origin journal entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOriginJournalEntryTerms

JournalEntryQueryInspector[] getOriginJournalEntryTerms()

Gets the origin journal entry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLatestJournalEntryIdTerms

IdTerm[] getLatestJournalEntryIdTerms()

Gets the latest journal entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLatestJournalEntryTerms

JournalEntryQueryInspector[] getLatestJournalEntryTerms()

Gets the latest journal entry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBranchQueryInspectorRecord

BranchQueryInspectorRecord getBranchQueryInspectorRecord(Type branchRecordType)
                                                  throws OperationFailedException

Gets the branch query inspector record corresponding to the given Branch record Type .

Parameters:

branchRecordType - a branch record type

Returns:

the branch query inspector record

Throws:

NullArgumentException - branchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(branchRecordType) is false

Compliance:

mandatory - This method must be implemented.