Interface | osid.journaling.JournalQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
Description |
This is the query inspector for examining journal searches. | ||
Method | getJournalEntryIdTerms | ||
Description |
Gets the journal entry | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalEntryTerms | ||
Description |
Gets the journal entry query terms. | ||
Return | osid.journaling.JournalEntryQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getBranchIdTerms | ||
Description |
Gets the branch | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getBranchTerms | ||
Description |
Gets the branch query terms. | ||
Return | osid.journaling.BranchQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorJournalIdTerms | ||
Description |
Gets the ancestor journal | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorJournalTerms | ||
Description |
Gets the ancestor journal query terms. | ||
Return | osid.journaling.JournalQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantJournalIdTerms | ||
Description |
Gets the descendant journal | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantJournalTerms | ||
Description |
Gets the descendant journal query terms. | ||
Return | osid.journaling.JournalQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalQueryInspectorRecord | ||
Description |
Gets the journal query inspector record corresponding
to the given | ||
Parameters | osid.type.Type | journalRecordType | a journal record type |
Return | osid.journaling.records.JournalQueryInspectorRecord | the journal query inspector record | |
Errors | NULL_ARGUMENT | journalRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(journalRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |