org.osid.journaling

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

Methods

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

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

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.