OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
journaling package
Version 3.0.0
Release Candidate Preview
| Interface | osid.journaling.JournalEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining journal entry queries. | ||
| 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 | getSourceIdTerms | ||
| Description |
Gets the source | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVersionIdTerms | ||
| Description |
Gets the version | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimestampTerms | ||
| Description |
Gets the timestamp query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntriesSinceTerms | ||
| Description |
Gets the entries since query terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentTerms | ||
| Description |
Gets the agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalIdTerms | ||
| Description |
Gets the journal | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalTerms | ||
| Description |
Gets the journal query terms. | ||
| Return | osid.journaling.JournalQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalEntryQueryInspectorRecord | ||
| Description |
Gets the journal entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | journalEntryRecordType | a journal entry record type |
| Return | osid.journaling.records.JournalEntryQueryInspectorRecord | the journal entry query inspector record | |
| Errors | NULL_ARGUMENT | journalEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(journalEntryRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |