OSID - osid.billing.PeriodQuery Service Interface Definition

Interface	osid.billing.PeriodQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.billing.BusinessQuery`
	`osid.billing.EntryQuery`
	`osid.billing.PeriodQuerySession`
	`osid.billing.PeriodSearchSession`
	`osid.billing.PeriodSmartBusinessSession`
	`osid.billing.payment.PaymentQuery`
Description	This is the query for searching periods. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchDisplayLabel
Description	Adds a display label for this query.
Parameters	`string`	`label`	label string to match
	`osid.type.Type`	`stringMatchType`	the label match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`label` not of `stringMatchType`
	NULL_ARGUMENT		`label` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDisplayLabel
Description	Matches a display label that has any value.
Parameters	`boolean`	`match`	`true` to match customers with any label, `false` to match assets with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabelTerms
Description	Clears the display label query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOpenDate
Description	Matches the open date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOpenDate
Description	Matches a period that has any open date assigned.
Parameters	`boolean`	`match`	`true` to match periods with any open date, `false` to match events with no open date
Compliance	`mandatory`		This method must be implemented.
Method	clearOpenDateTerms
Description	Clears the open date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCloseDate
Description	Matches the close date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCloseDate
Description	Matches a period that has any close date assigned.
Parameters	`boolean`	`match`	`true` to match periods with any close date, `false` to match events with no close date
Compliance	`mandatory`		This method must be implemented.
Method	clearCloseDateTerms
Description	Clears the close date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBillingDate
Description	Matches the billing date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBillingDate
Description	Matches a period that has any billing date assigned.
Parameters	`boolean`	`match`	`true` to match periods with any billing date, `false` to match events with no billing date
Compliance	`mandatory`		This method must be implemented.
Method	clearBillingDateTerms
Description	Clears the billing date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDueDate
Description	Matches the due date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDueDate
Description	Matches a period that has any due date assigned.
Parameters	`boolean`	`match`	`true` to match periods with any due date, `false` to match events with no due date
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDateTerms
Description	Clears the due date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match periods 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` query 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.billing.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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodQueryRecord
Description	Gets the period query record corresponding to the given `Period` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`periodRecordType`	a period record type
Return	`osid.billing.records.PeriodQueryRecord`		the period query record
Errors	NULL_ARGUMENT		`periodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(periodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.