OSID - osid.journaling.JournalQuery Service Interface Definition

Interface	osid.journaling.JournalQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.journaling.JournalEntryQuery`
	`osid.journaling.JournalQuery`
	`osid.journaling.JournalQuerySession`
	`osid.journaling.JournalSearchSession`
Description	This is the query for searching for journals. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchJournalEntryId
Description	Sets the journal entry `Id` for this query to match entries assigned to journals.
Parameters	`osid.id.Id`	`journalEntryId`	a journal entry `Id`
Parameters	`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	clearJournalEntryIdTerms
Description	Clears the journal entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryQuery
Description	Tests if a journal entry query is available.
Return	`boolean`		`true` if a journal entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntryQuery
Description	Gets the query for a journal.
Return	`osid.journaling.JournalEntryQuery`		the journal entry query
Errors	UNIMPLEMENTED		`supportsJournalEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalEntryQuery()` is `true`.
Method	matchAnyJournalEntry
Description	Matches journals with any journal entry.
Parameters	`boolean`	`match`	`true` to match journals with any journal entry, `false` to match journals with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearJournalEntryTerms
Description	Clears the journal entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBranchId
Description	Sets the branch `Id` for this query to match branches assigned to journals.
Parameters	`osid.id.Id`	`branchId`	a branch `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`branchId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBranchIdTerms
Description	Clears the branch `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchQuery
Description	Tests if a branch query is available.
Return	`boolean`		`true` if a branch query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchQuery
Description	Gets the query for a branch.
Return	`osid.journaling.BranchQuery`		the branch query
Errors	UNIMPLEMENTED		`supportsBranchQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBranchQuery()` is `true`.
Method	matchAnyBranch
Description	Matches journals with any branches.
Parameters	`boolean`	`match`	`true` to match journals with any branch, `false` to match journals with no branches
Compliance	`mandatory`		This method must be implemented.
Method	clearBranchTerms
Description	Clears the branch terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorJournalId
Description	Sets the journal `Id` for this query to match journals that have the specified journal as an ancestor.
Parameters	`osid.id.Id`	`journalId`	a journal `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`journalId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorJournalIdTerms
Description	Clears the ancestor journal `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorJournalQuery
Description	Tests if a `JournalQuery` is available.
Return	`boolean`		`true` if a journal query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorJournalQuery
Description	Gets the query for a journal. Multiple retrievals produce a nested `OR` term.
Return	`osid.journaling.JournalQuery`		the journal query
Errors	UNIMPLEMENTED		`supportsAncestorJournalQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorJournalQuery()` is `true`.
Method	matchAnyAncestorJournal
Description	Matches journals with any ancestor.
Parameters	`boolean`	`match`	`true` to match journals with any ancestor, `false` to match root journals
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorJournalTerms
Description	Clears the ancestor journal terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantJournalId
Description	Sets the journal `Id` for this query to match journals that have the specified journal as a descendant.
Parameters	`osid.id.Id`	`journalId`	a journal `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`journalId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantJournalIdTerms
Description	Clears the descendant journal `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantJournalQuery
Description	Tests if a `JournalQuery` is available.
Return	`boolean`		`true` if a journal query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantJournalQuery
Description	Gets the query for a journal. Multiple retrievals produce a nested `OR` term.
Return	`osid.journaling.JournalQuery`		the journal query
Errors	UNIMPLEMENTED		`supportsDescendantJournalQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantJournalQuery()` is `true`.
Method	matchAnyDescendantJournal
Description	Matches journals with any descendant.
Parameters	`boolean`	`match`	`true` to match journals with any descendant, `false` to match leaf journals
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantJournalTerms
Description	Clears the descendant journal terms.
Compliance	`mandatory`		This method must be implemented.
Method	getJournalQueryRecord
Description	Gets the journal query record corresponding to the given `Journal` record `Type` .Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`journalRecordType`	a journal record type
Return	`osid.journaling.records.JournalQueryRecord`		the journal query 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.