Interface | osid.billing.BusinessAdminSession | ||
---|---|---|---|
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 | canCreateBusinesses | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Business creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBusinessWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | businessRecordTypes | array of business record types |
Return | boolean | true if Business creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | businessRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessFormForCreate | ||
Description |
Gets the business form for creating new businesses. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | businessRecordTypes | array of business record types |
Return | osid.billing.BusinessForm | the business form | |
Errors | NULL_ARGUMENT | businessRecordTypes 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 | createBusiness | ||
Description |
Creates a new | ||
Parameters | osid.billing.BusinessForm | businessForm | the form for this Business |
Return | osid.billing.Business | the new Business | |
Errors | ILLEGAL_STATE | businessForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | businessForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | businessForm did not originate from
getBusinessFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBusinesses | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Business modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessFormForUpdate | ||
Description |
Gets the business form for updating an existing business. A new business form should be requested for each update transaction. | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
Return | osid.billing.BusinessForm | the business form | |
Errors | NOT_FOUND | businessId is not found | |
NULL_ARGUMENT | businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBusiness | ||
Description |
Updates an existing business. | ||
Parameters | osid.billing.BusinessForm | businessForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | businessForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | businessForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | businessForm did not originate from
getBusinessFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBusinesses | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Business deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBusiness | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | businessId | the Id of the Business to remove |
Errors | NOT_FOUND | businessId not found | |
NULL_ARGUMENT | businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBusinessAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Business aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBusiness | ||
Description |
Adds an | ||
Parameters | osid.id.Id | businessId | the Id of a Business |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | aliasId is in use as a primary Id | ||
NULL_ARGUMENT | businessId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |