OSID Specifications
journaling package
Version 3.1.0
journaling package
Version 3.1.0
| Interface | osid.journaling.BranchQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
| Used By | osid.journaling.BranchSearchResults | ||
osid.journaling.BranchSmartJournalSession | |||
osid.journaling.JournalEntryQueryInspector | |||
osid.journaling.JournalQueryInspector | |||
| Description |
This is the query inspector for examining branch queries. | ||
| Method | getOriginJournalEntryIdTerms | ||
| Description |
Gets the origin journal entry | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOriginJournalEntryTerms | ||
| Description |
Gets the origin journal entry query terms. | ||
| Return | osid.journaling.JournalEntryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLatestJournalEntryIdTerms | ||
| Description |
Gets the latest journal entry | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLatestJournalEntryTerms | ||
| Description |
Gets the latest journal entry query terms. | ||
| Return | osid.journaling.JournalEntryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBranchQueryInspectorRecord | ||
| Description |
Gets the branch query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | branchRecordType | a branch record type |
| Return | osid.journaling.records.BranchQueryInspectorRecord | the branch query inspector record | |
| Errors | NULL_ARGUMENT | branchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(branchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |