Interface | osid.journaling.BranchQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidOperableQuery | |||
Description |
This is the query for searching branches Each method
specifies an | ||
Method | matchOriginJournalEntryId | ||
Description |
Sets the origin journal entry | ||
Parameters | osid.id.Id | journalEntryId | a journal entry Id Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | journalEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOriginJournalEntryIdTerms | ||
Description |
Clears the origin journal entry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOriginJournalEntryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a journal entry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOriginJournalEntryQuery | ||
Description |
Gets the query for an origin journal entry. Multiple
retrievals produce a nested | ||
Return | osid.journaling.JournalEntryQuery | the origin journal entry query | |
Errors | UNIMPLEMENTED | supportsOriginJournalEntryQuery() is false | |
Compliance | optional | This method must be implemented if supportsOriginJournalEntryQuery()
is true. | |
Method | clearOriginJournalEntryTerms | ||
Description |
Clears the origin journal entry terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLatestJournalEntryId | ||
Description |
Sets the latest journal entry | ||
Parameters | osid.id.Id | journalEntryId | a journal entry Id Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | journalEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLatestJournalEntryIdTerms | ||
Description |
Clears the latest journal entry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLatestJournalEntryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a journal entry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLatestJournalEntryQuery | ||
Description |
Gets the query for a latest journal entry. Multiple
retrievals produce a nested | ||
Return | osid.journaling.JournalEntryQuery | the latest journal entry query | |
Errors | UNIMPLEMENTED | supportsOriginJournalEntryQuery() is false | |
Compliance | optional | This method must be implemented if supportsOriginJournalEntryQuery()
is true. | |
Method | clearLatestJournalEntryTerms | ||
Description |
Clears the latest journal entry terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBranchQueryRecord | ||
Description |
Gets the branch query record corresponding to the given
| ||
Parameters | osid.type.Type | branchRecordType | a branch record type |
Return | osid.journaling.records.BranchQueryRecord | the branch query 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. |