Interface JournalQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface JournalQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining journal searches.

  • Method Details

    • getJournalEntryIdTerms

      IdTerm[] getJournalEntryIdTerms()
      Gets the journal entry Id query terms.
      Specified by:
      getJournalEntryIdTerms in interface OsidObjectQueryInspector
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getJournalEntryTerms

      JournalEntryQueryInspector[] getJournalEntryTerms()
      Gets the journal entry query terms.
      Specified by:
      getJournalEntryTerms in interface OsidObjectQueryInspector
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBranchIdTerms

      IdTerm[] getBranchIdTerms()
      Gets the branch Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBranchTerms

      BranchQueryInspector[] getBranchTerms()
      Gets the branch query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorJournalIdTerms

      IdTerm[] getAncestorJournalIdTerms()
      Gets the ancestor journal Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorJournalTerms

      JournalQueryInspector[] getAncestorJournalTerms()
      Gets the ancestor journal query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantJournalIdTerms

      IdTerm[] getDescendantJournalIdTerms()
      Gets the descendant journal Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantJournalTerms

      JournalQueryInspector[] getDescendantJournalTerms()
      Gets the descendant journal query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getJournalQueryInspectorRecord

      JournalQueryInspectorRecord getJournalQueryInspectorRecord(Type journalRecordType) throws OperationFailedException
      Gets the journal query inspector record corresponding to the given Journal record Type .
      Parameters:
      journalRecordType - a journal record type
      Returns:
      the journal query inspector record
      Throws:
      NullArgumentException - journalRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(journalRecordType) is false
      Compliance:
      mandatory - This method must be implemented.