Interface | osid.provisioning.ProvisionReturnSession | ||
---|---|---|---|
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 | getBrokerId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Broker Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBroker | ||
Description |
Gets the | ||
Return | osid.provisioning.Broker | the broker | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProvisionReturns | ||
Description |
Tests if this user can return | ||
Return | boolean | false if Provision return is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProvisionReturnWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | provisionReturnRecordTypes | array of provision return record types |
Return | boolean | true if ProvisionReturn creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | provisionReturnRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionReturnFormForCreate | ||
Description |
Gets the provision return form for creating new provisions. A new form should be requested for each return transaction. | ||
Parameters | osid.id.Id | provisionId | the Id for the provision |
osid.type.Type[] | provisionReturnRecordTypes | array of provision return record types | |
Return | osid.provisioning.ProvisionReturnForm | the provision return form | |
Errors | NOT_FOUND | provisionId is not found | |
NULL_ARGUMENT | provisionId or provisionReturnRecordTypes 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 | createProvisionReturn | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.ProvisionReturnForm | provisionReturnForm | the form for this ProvisionReturn |
Return | osid.provisioning.ProvisionReturn | the new ProvisionReturn | |
Errors | ILLEGAL_STATE | provisionForm is already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | provisionReturnForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | provisionReturnForm did not oroginate from
getProvisionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProvisionReturns | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ProvisionReturn modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionReturnFormForUpdate | ||
Description |
Gets the provision form for updating an existing provision return. A new provision return form should be requested for each update transaction. | ||
Parameters | osid.id.Id | provisionReturnId | the Id of the ProvisionReturn |
Return | osid.provisioning.ProvisionReturnForm | the provision return form | |
Errors | NOT_FOUND | provisionReturnId is not found | |
NULL_ARGUMENT | provisionReturnId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProvisionReturn | ||
Description |
Updates an existing provision return. | ||
Parameters | osid.provisioning.ProvisionReturnForm | provisionReturnForm | the form containing the elements to be updated |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | provisionReturnId is not found | ||
NULL_ARGUMENT | provisionReturnForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | provisionReturnForm did not originate from
getProvisionReturnFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProvisionReturns | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Provision deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProvisionReturn | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | provisionReturnId | the Id of the ProvisionReturn to remove |
Errors | NOT_FOUND | provisionReturnId not found | |
NULL_ARGUMENT | provisionReturnId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |