OSID - osid.resourcing.EffortQuery Service Interface Definition

Interface	osid.resourcing.EffortQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.resourcing.CommissionQuery`
	`osid.resourcing.EffortQuerySession`
	`osid.resourcing.EffortSearchSession`
	`osid.resourcing.EffortSmartFoundrySession`
	`osid.resourcing.FoundryQuery`
Description	This is the query for searching efforts. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	the 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` query 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. 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCommissionId
Description	Sets the commission `Id` for this query.
Parameters	`osid.id.Id`	`commissionId`	the commission `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commissionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionIdTerms
Description	Clears the commission `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommissionQuery
Description	Tests if a `CommissionQuery` is available.
Return	`boolean`		`true` if a commission query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionQuery
Description	Gets the query for a commission. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.CommissionQuery`		the commission query
Errors	UNIMPLEMENTED		`supportsCommissionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommissionQuery()` is `true` .
Method	clearCommissionTerms
Description	Clears the commission query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeSpent
Description	Matches the time spent between the given durations inclusive.
Parameters	`osid.calendaring.Duration`	`start`	start range
	`osid.calendaring.Duration`	`end`	end range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeSpentTerms
Description	Clears the time spent query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Sets the foundry `Id` for this query to match efforts assigned to foundries.
Parameters	`osid.id.Id`	`foundryId`	the foundry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFoundryIdTerms
Description	Clears the foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFoundryQuery
Description	Tests if a `FoundryQuery` is available.
Return	`boolean`		`true` if a foundry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQuery
Description	Gets the query for a foundry. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFoundryQuery()` is `true` .
Method	clearFoundryTerms
Description	Clears the foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getEffortQueryRecord
Description	Gets the effort query record corresponding to the given `Effort` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`effortRecordType`	an effort record type
Return	`osid.resourcing.records.EffortQueryRecord`		the effort query record
Errors	NULL_ARGUMENT		`effortRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(effortRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.