OSID - osid.journaling.JournalEntryQuery Service Interface Definition

Interface	osid.journaling.JournalEntryQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	This is the query for searching journal entries. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
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	clearBranchTerms
Description	Clears the branch terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSourceId
Description	Sets the source `Id.`
Parameters	`osid.id.Id`	`sourceId`	a source `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceIdTerms
Description	Clears the source `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVersionId
Description	Sets the version `Id.`
Parameters	`osid.id.Id`	`versionId`	a version `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`versionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVersionIdTerms
Description	Clears the version `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimestamp
Description	Matches entries falling between the given times inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start time
	`osid.calendaring.DateTime`	`to`	end time
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestampTerms
Description	Clears the timestamp terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEntriesSince
Description	Matches entries following the given timestamp inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start time
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`from` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntriesSinceTerms
Description	Clears the entries since terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Sets a resource `Id.`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAgentId
Description	Sets an agent `Id.`
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQuery
Description	Gets the query for an agent query. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true.`
Method	clearAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchJournalId
Description	Sets the journal `Id` for this query to match entries assigned to journals.
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	clearJournalIdTerms
Description	Clears the journal `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalQuery
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	getJournalQuery
Description	Gets the query for a journal query. Multiple retrievals produce a nested `OR` term.
Return	`osid.journaling.JournalQuery`		the journal query
Errors	UNIMPLEMENTED		`supportsJournalQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalQuery()` is `true.`
Method	clearJournalTerms
Description	Clears the journal terms.
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntryQueryRecord
Description	Gets the journal entry query record corresponding to the given `JournalEntry` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`journalEntryRecordType`	a journal entry record type
Return	`osid.journaling.records.JournalEntryQueryRecord`		the journal entry query 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.