Interface | osid.recipe.CookbookAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateCookbooks | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Cookbook creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCookbookWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | cookbookRecordTypes | array of cook book types |
Return | boolean | true if Cookbook creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | cookbookRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookFormForCreate | ||
Description |
Gets the cook book form for creating new cook books. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | cookbookRecordTypes | array of cook book types |
Return | osid.recipe.CookbookForm | the cook book form | |
Errors | NULL_ARGUMENT | cookbookRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCookbook | ||
Description |
Creates a new | ||
Parameters | osid.recipe.CookbookForm | cookbookForm | the form for this Cookbook |
Return | osid.recipe.Cookbook | the new Cookbook | |
Errors | ILLEGAL_STATE | cookbookForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | cookbookForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cookbookForm did not originate from
getCookbookFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCookbooks | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Cookbook modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookFormForUpdate | ||
Description |
Gets the cook book form for updating an existing cookbook. A new cook book form should be requested for each update transaction. | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.CookbookForm | the cook book form | |
Errors | NOT_FOUND | cookbookId is not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCookbook | ||
Description |
Updates an existing cookbook. | ||
Parameters | osid.recipe.CookbookForm | cookbookForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | cookbookForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | cookbookForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cookbookForm did not originate from
getCookbookFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCookbooks | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Cookbook deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCookbook | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook to remove |
Errors | NOT_FOUND | cookbookId not found | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCookbookAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Cookbook aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCookbook | ||
Description |
Adds an | ||
Parameters | osid.id.Id | cookbookId | the Id of an Cookbook |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | cookbookId not found | ||
NULL_ARGUMENT | cookbookId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |