OSID - osid.recipe.RecipeQuery Service Interface Definition

Interface	osid.recipe.RecipeQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSourceableQuery`
Used By	`osid.recipe.CookbookQuery`
	`osid.recipe.DirectionQuery`
	`osid.recipe.RecipeQuerySession`
	`osid.recipe.RecipeSearchSession`
	`osid.recipe.RecipeSmartCookbookSession`
Description	This is the query for searching recipes. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchTotalEstimatedDuration
Description	Matches recipes with an estimated duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`start`	starting duration
	`osid.calendaring.Duration`	`end`	ending duration
	`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	matchAnyTotalEstimatedDuration
Description	Matches recipes with any estimated duration.
Parameters	`boolean`	`match`	`true` to match directions with any estimated duration, `false` to match directions with no estimated duration
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalEstimatedDurationTerms
Description	Clears the duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssetId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	the asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetIdTerms
Description	Clears the asset `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if an `AssetQuery` is available.
Return	`boolean`		`true` if an asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssetQuery()` is `true`.
Method	matchAnyAsset
Description	Matches directions with any asset.
Parameters	`boolean`	`match`	`true` to match directions with any asset, `false` to match directions with no assets
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetTerms
Description	Clears the asset query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDirectionId
Description	Sets the direction `Id` for this query.
Parameters	`osid.id.Id`	`qualifierId`	the direction `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`directionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDirectionIdTerms
Description	Clears the direction `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionQuery
Description	Tests if a `DirectionQuery` is available.
Return	`boolean`		`true` if a direction query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionQuery
Description	Gets the query for a direction. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.DirectionQuery`		the direction query
Errors	UNIMPLEMENTED		`supportsDirectionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectionQuery()` is `true`.
Method	matchAnyDirection
Description	Matches recipes that have any direction.
Parameters	`boolean`	`match`	`true` to match recipes with any direction, `false` to match recipes with no direction
Compliance	`mandatory`		This method must be implemented.
Method	clearDirectionTerms
Description	Clears the direction query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTotalDuration
Description	Matches recipes with an estimated duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`start`	starting duration
	`osid.calendaring.Duration`	`end`	ending duration
	`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	clearTotalDurationTerms
Description	Clears the duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCookbookId
Description	Sets the award `Id` for this query to match recipes assigned to cookbooks.
Parameters	`osid.id.Id`	`cookbookId`	a cookbook `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cookbookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCookbookIdTerms
Description	Clears the cookbook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookQuery
Description	Tests if a `CookbookQuery` is available.
Return	`boolean`		`true` if a cookbook query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookQuery
Description	Gets the query for a cookbook. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.CookbookQuery`		the cookbook query
Errors	UNIMPLEMENTED		`supportsCookbookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCookbookQuery()` is `true`.
Method	clearCookbookTerms
Description	Clears the cookbook query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeQueryRecord
Description	Gets the recipe query record corresponding to the given `Recipe` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`recipeRecordType`	a recipe record type
Return	`osid.recipe.records.RecipeQueryRecord`		the recipe query record
Errors	NULL_ARGUMENT		`recipeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(recipeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.