Interface | osid.recipe.RecipeQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSourceableQuery | |||
Description |
This is the query for searching recipes. Each method match
specifies an | ||
Method | matchTotalEstimatedDuration | ||
Description |
Matches recipies 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 | |
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 | ||
Parameters | osid.id.Id | assetId | the asset Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssetQuery | ||
Description |
Tests if an | ||
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 | ||
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 | ||
Parameters | osid.id.Id | qualifierId | the direction Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionQuery | ||
Description |
Tests if a | ||
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 | ||
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 recipies 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 | |
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 | ||
Parameters | osid.id.Id | cookbookId | a cook book Id |
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 cook book | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a cook book 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 | ||
Return | osid.recipe.CookbookQuery | the cook book query | |
Errors | UNIMPLEMENTED | supportsCookbookQuery() is false | |
Compliance | optional | This method must be implemented if supportsCookbookQuery()
is true. | |
Method | clearCookbookTerms | ||
Description |
Clears the cook book query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeQueryRecord | ||
Description |
Gets the recipe query record corresponding to the given
| ||
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. |