OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining journal searches.

MethodgetJournalEntryIdTerms
Description

Gets the journal entry Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntryTerms
Description

Gets the journal entry query terms.

Returnosid.journaling.JournalEntryQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetBranchIdTerms
Description

Gets the branch Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetBranchTerms
Description

Gets the branch query terms.

Returnosid.journaling.BranchQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorJournalIdTerms
Description

Gets the ancestor journal Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorJournalTerms
Description

Gets the ancestor journal query terms.

Returnosid.journaling.JournalQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantJournalIdTerms
Description

Gets the descendant journal Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantJournalTerms
Description

Gets the descendant journal query terms.

Returnosid.journaling.JournalQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetJournalQueryInspectorRecord
Description

Gets the journal query inspector record corresponding to the given Journal record Type.

Parametersosid.type.TypejournalRecordTypea journal record type
Returnosid.journaling.records.JournalQueryInspectorRecordthe journal query inspector record
ErrorsNULL_ARGUMENT journalRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalRecordType) is false
CompliancemandatoryThis method must be implemented.