Interface | osid.billing.CategoryAdminSession | ||
---|---|---|---|
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 | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.billing.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCategories | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Category creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCategoryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | categoryRecordTypes | array of category record types |
Return | boolean | true if Category creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | categoryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCategoryFormForCreate | ||
Description |
Gets the category form for creating new categories. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | categoryRecordTypes | array of category record types |
Return | osid.billing.CategoryForm | the category form | |
Errors | NULL_ARGUMENT | categoryRecordTypes 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 | createCategory | ||
Description |
Creates a new | ||
Parameters | osid.billing.CategoryForm | categoryForm | the form for this Category |
Return | osid.billing.Category | the new Category | |
Errors | ILLEGAL_STATE | categoryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | categoryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from getCategoryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCategories | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Category modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCategoryFormForUpdate | ||
Description |
Gets the category form for updating an existing category. A new category form should be requested for each update transaction. | ||
Parameters | osid.id.Id | categoryId | the Id of the Category |
Return | osid.billing.CategoryForm | the category form | |
Errors | NOT_FOUND | categoryId is not found | |
NULL_ARGUMENT | categoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCategory | ||
Description |
Updates an existing category. | ||
Parameters | osid.billing.CategoryForm | categoryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | categoryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | categoryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from getCategoryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCategories | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Category deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCategory | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | categoryId | the Id of the Category to remove |
Errors | NOT_FOUND | categoryId not found | |
NULL_ARGUMENT | categoryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCategoryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Category aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCategory | ||
Description |
Adds an | ||
Parameters | osid.id.Id | categoryId | the Id of a Category |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | categoryId not found | ||
NULL_ARGUMENT | categoryId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |