OSID - osid.financials.posting.PostEntryQuery Service Interface Definition

Interface	osid.financials.posting.PostEntryQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.financials.posting.PostEntryQuerySession`
	`osid.financials.posting.PostEntrySearchSession`
	`osid.financials.posting.PostEntrySmartBusinessSession`
	`osid.financials.posting.PostQuery`
Description	This is the query for searching post entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchPostId
Description	Sets the post `Id` for this query.
Parameters	`osid.id.Id`	`postId`	a post `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`postId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostIdTerms
Description	Clears the post `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostQuery
Description	Tests if a `PostQuery` is available.
Return	`boolean`		`true` if a post query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostQuery
Description	Gets the query for a post. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.posting.PostQuery`		the post query
Errors	UNIMPLEMENTED		`supportsPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` is `true`.
Method	clearPostTerms
Description	Clears the post terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAccountId
Description	Sets the account `Id` for this query.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`accountId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountIdTerms
Description	Clears the account `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountQuery
Description	Tests if an `AccountQuery` is available.
Return	`boolean`		`true` if an account query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAccountQuery()` is `true`.
Method	matchAnyAccount
Description	Matches entries that have any account set.
Parameters	`boolean`	`match`	`true` to match entries with any account, `false` to match entries with no account
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountTerms
Description	Clears the account terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityIdTerms
Description	Clears the activity `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an `ActivityQuery` is available.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true`.
Method	matchAnyActivity
Description	Matches entries that have any activity set.
Parameters	`boolean`	`match`	`true` to match entries with any activity, `false` to match entries with no activity
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAmount
Description	Matches the amount between the given range inclusive.
Parameters	`osid.financials.Currency`	`low`	start of range
	`osid.financials.Currency`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAmount
Description	Matches entries that have any amount set.
Parameters	`boolean`	`match`	`true` to match entries with any amount, `false` to match entries with no amount
Compliance	`mandatory`		This method must be implemented.
Method	clearAmountTerms
Description	Clears the amount terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDebit
Description	Matches entries that have debit amounts.
Parameters	`boolean`	`match`	`true` to match entries with a debit amount, `false` to match entries with a credit amount
Compliance	`mandatory`		This method must be implemented.
Method	clearDebitTerms
Description	Clears the debit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match post entries assigned to businesses.
Parameters	`osid.id.Id`	`businessId`	the business `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`businessId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBusinessIdTerms
Description	Clears the business `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if a `BusinessQuery` is available.
Return	`boolean`		`true` if a business query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBusinessQuery()` is `true`.
Method	clearBusinessTerms
Description	Clears the business terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntryQueryRecord
Description	Gets the post entry query record corresponding to the given `PostEntry` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`postEntryRecordType`	a post entry record type
Return	`osid.financials.posting.records.PostEntryQueryRecord`		the post entry query record
Errors	NULL_ARGUMENT		`postEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(postEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.