OSID - osid.OsidTemporalQuery Service Interface Definition

Interface	osid.OsidTemporalQuery
Implements	`osid.OsidQuery`
Implemented By	`osid.financials.ActivityQuery`
	`osid.OsidRelationshipQuery`
	`osid.OsidEnablerQuery`
	`osid.room.construction.RenovationQuery`
	`osid.room.construction.ProjectQuery`
	`osid.offering.ResultQuery`
	`osid.voting.BallotQuery`
	`osid.calendaring.EventQuery`
	`osid.personnel.OrganizationQuery`
	`osid.personnel.PositionQuery`
	`osid.checklist.TodoQuery`
	`osid.billing.CustomerQuery`
	`osid.billing.payment.PayerQuery`
	`osid.room.RoomQuery`
	`osid.room.FloorQuery`
	`osid.room.BuildingQuery`
Description	This is the query interface for searching temporal objects. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchEffective
Description	Match effective objects where the current date falls within the start and end dates inclusive.
Parameters	`boolean`	`match`	`true` to match any effective, `false` to match ineffective
Compliance	`mandatory`		This method must be implemented.
Method	clearEffectiveTerms
Description	Clears the effective query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartDate
Description	Matches temporals whose start date falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartDate
Description	Matches temporals with any start date set.
Parameters	`boolean`	`match`	`true` to match any start date, `false` to match no start date
Compliance	`mandatory`		This method must be implemented.
Method	clearStartDateTerms
Description	Clears the start date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndDate
Description	Matches temporals whose effective end date falls in between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`start` is less than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEndDate
Description	Matches temporals with any end date set.
Parameters	`boolean`	`match`	`true` to match any end date, `false` to match no start date
Compliance	`mandatory`		This method must be implemented.
Method	clearEndDateTerms
Description	Clears the end date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is less than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the date query terms.
Compliance	`mandatory`		This method must be implemented.