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

Interface	osid.financials.posting.PostQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.financials.posting.PostEntryQuery`
	`osid.financials.posting.PostQuery`
	`osid.financials.posting.PostQuerySession`
	`osid.financials.posting.PostSearchSession`
	`osid.financials.posting.PostSmartBusinessSession`
Description	This is the query for searching posts. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchFiscalPeriodId
Description	Sets the fiscal period `Id` for this query.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foscalPeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodIdTerms
Description	Clears the fiscal period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodQuery
Description	Tests if a `FiscalPeriod` is available.
Return	`boolean`		`true` if a fiscal period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQuery
Description	Gets the query for a fiscal period. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Errors	UNIMPLEMENTED		`supportsFiscalPeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFiscalPeriodQuery()` is `true` .
Method	matchAnyFiscalPeriod
Description	Matches any fiscal period.
Parameters	`boolean`	`match`	`true` to match posts with any fiscal period, `false` to match posts with no fiscal period
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodTerms
Description	Clears the fiscal period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPosted
Description	Matches posts that have been posted.
Parameters	`boolean`	`match`	`true` to match posted posts `false` to match unposted posts
Compliance	`mandatory`		This method must be implemented.
Method	clearPostedTerms
Description	Clears the posted terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches the date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	start of range
	`osid.calendaring.DateTime`	`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	matchAnyDate
Description	Matches items that have any date set.
Parameters	`boolean`	`match`	`true` to match items with any date, `false` to match items with no date
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPostEntryId
Description	Sets the post entry `Id` for this query to match posts that have a related post entries.
Parameters	`osid.id.Id`	`postEntryId`	a post entry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`postEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostEntryIdTerms
Description	Clears the post entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostEntryQuery
Description	Tests if a `PostEntryQuery` is available for the location.
Return	`boolean`		`true` if a post entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntryQuery
Description	Gets the query for a post entries. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.posting.PostEntryQuery`		the post entry query
Errors	UNIMPLEMENTED		`supportsPostEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryQuery()` is `true` .
Method	matchAnyPostEntry
Description	Matches any posts with post entries.
Parameters	`boolean`	`match`	`true` to match posts with any post entry, `false` to match posts with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearPostEntryTerms
Description	Clears the post entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCorrectedPostId
Description	Sets the post entry `Id` for this query to match posts that have a corrected post.
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	clearCorrectedPostIdTerms
Description	Clears the corrected post `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCorrectedPostQuery
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	getCorrectedPostQuery
Description	Gets the query for a corrected posts. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.posting.PostQuery`		the post query
Errors	UNIMPLEMENTED		`supportsCorrectedPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCorrectedPostQuery()` is `true` .
Method	matchAnyCorrectedPost
Description	Matches any posts with corrected posts.
Parameters	`boolean`	`match`	`true` to match posts with any corrected post, `false` to match posts with no corrected posts
Compliance	`mandatory`		This method must be implemented.
Method	clearCorrectedPostTerms
Description	Clears the corrected post terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match posts 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	getPostQueryRecord
Description	Gets the post query record corresponding to the given `Post` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`postRecordType`	a post record type
Return	`osid.financials.posting.records.PostQueryRecord`		the post query record
Errors	NULL_ARGUMENT		`postRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(postRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.