Interface | osid.acknowledgement.CreditAdminSession | ||
---|---|---|---|
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 | getBillingId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Billing Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBilling | ||
Description |
Gets the | ||
Return | osid.acknowledgement.Billing | the billing | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCredits | ||
Description |
Tests if this user can create credits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known creating a | ||
Return | boolean | false if Credit creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCreditWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | creditRecordTypes | array of credit record types |
Return | boolean | true if Credit creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | creditRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditFormForCreate | ||
Description |
Gets the credit form for creating new credits. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | referenceId | the reference Id |
osid.id.Id | resourceId | the resource Id | |
osid.type.Type[] | creditRecordTypes | array of credit record types to be included in the create operation or an empty list if none | |
Return | osid.acknowledgement.CreditForm | the credit form | |
Errors | NOT_FOUND | referenceId or resourceId is not found | |
NULL_ARGUMENT | referenceId, resourceId or creditRecordTypes
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cannot get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCredit | ||
Description |
Creates a new | ||
Parameters | osid.acknowledgement.CreditForm | creditForm | the form for this Credit |
Return | osid.acknowledgement.Credit | the new Credit | |
Errors | ILLEGAL_STATE | creditForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | creditForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | creditForm did not originate from
getCreditFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCredits | ||
Description |
Tests if this user can update credits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating a | ||
Return | boolean | false if Credit modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditFormForUpdate | ||
Description |
Gets the credit form for updating an existing credit. A new credit form should be requested for each update transaction. | ||
Parameters | osid.id.Id | creditId | the Id of the Credit |
Return | osid.acknowledgement.CreditForm | the credit form | |
Errors | NOT_FOUND | creditId is not found | |
NULL_ARGUMENT | creditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCredit | ||
Description |
Updates an existing credit. | ||
Parameters | osid.acknowledgement.CreditForm | creditForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | creditForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | creditForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | creditForm did not originate from
getCreditFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCredits | ||
Description |
Tests if this user can delete credits. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting an | ||
Return | boolean | false if Credit deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredit | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | creditId | the Id of the Credit to remove |
Errors | NOT_FOUND | creditId not found | |
NULL_ARGUMENT | creditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCreditAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Credit aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCredit | ||
Description |
Adds an | ||
Parameters | osid.id.Id | creditId | the Id of a Credit |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | creditId not found | ||
NULL_ARGUMENT | creditId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |