Interface | osid.recipe.ProcedureQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching Procedures may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCookbookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Cookbook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbook | ||
Description |
Gets the | ||
Return | osid.recipe.Cookbook | the cookbook | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchProcedures | ||
Description |
Tests if this user can perform susbcription searches. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCookbookView | ||
Description |
Federates the view for methods in this session. A federated view will include procedures in cook books which are children of this cook book in the cook book hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCookbookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this cook book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProcedureQuery | ||
Description |
Gets a procedure query. | ||
Return | osid.recipe.ProcedureQuery | the procedure query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProceduresByQuery | ||
Description |
Gets a list of procedures matching the given procedure query. | ||
Parameters | osid.recipe.ProcedureQuery | procedureQuery | the procedure query |
Return | osid.recipe.ProcedureList | the returned ProcedureList | |
Errors | NULL_ARGUMENT | procedureQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | procedureQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |