Interface | osid.recipe.ProcedureLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving procedures. This lookup session defines several views:
The methods | ||
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 | canLookupProcedures | ||
Description |
Tests if this user can lookup procedures. 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 procedure lookup methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeProcedureView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryProcedureView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 | getProcedure | ||
Description |
Gets the | ||
Parameters | osid.id.Id | procedureId | the Id of the Procedure to retrieve |
Return | osid.recipe.Procedure | the returned Procedure | |
Errors | NOT_FOUND | no Procedure found with the given Id | |
NULL_ARGUMENT | procedureId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProceduresByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | procedureIds | the list of Ids to retrieve |
Return | osid.recipe.ProcedureList | the returned Procedure list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | procedureIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProceduresByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | procedureGenusType | a procedure genus type |
Return | osid.recipe.ProcedureList | the returned Procedure list | |
Errors | NULL_ARGUMENT | procedureGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProceduresByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | procedureGenusType | a procedure genus type |
Return | osid.recipe.ProcedureList | the returned Procedure list | |
Errors | NULL_ARGUMENT | procedureGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProceduresByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | procedureRecordType | a procedure record type |
Return | osid.recipe.ProcedureList | the returned Procedure list | |
Errors | NULL_ARGUMENT | procedureRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcedures | ||
Description |
Gets all procedures. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session. | ||
Return | osid.recipe.ProcedureList | a list of procedures | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |