| 1 | .. _label-uc-contract-add: |
|---|
| 2 | |
|---|
| 3 | Use-Case: Add a Contract |
|---|
| 4 | *********************************************************************** |
|---|
| 5 | |
|---|
| 6 | .. Description of a use case |
|---|
| 7 | .. The description must be formulated as seen from system (not: actors) |
|---|
| 8 | .. Describes those changes an (outside) actor can notice |
|---|
| 9 | .. Short and abstract as possible, as long as necessary. |
|---|
| 10 | .. Each use case must have at least one actor involved |
|---|
| 11 | .. Each use case must have a trigger and a result |
|---|
| 12 | |
|---|
| 13 | |
|---|
| 14 | Short Description |
|---|
| 15 | ----------------------------------------------------------------------- |
|---|
| 16 | |
|---|
| 17 | A contract is added for some customer |
|---|
| 18 | |
|---|
| 19 | Actor(s) |
|---|
| 20 | ----------------------------------------------------------------------- |
|---|
| 21 | |
|---|
| 22 | Staff |
|---|
| 23 | |
|---|
| 24 | |
|---|
| 25 | Trigger(s) |
|---|
| 26 | ----------------------------------------------------------------------- |
|---|
| 27 | |
|---|
| 28 | - Imports (modifying existing data) |
|---|
| 29 | - Web form(s) submitted by authorized user. |
|---|
| 30 | |
|---|
| 31 | |
|---|
| 32 | Result(s) |
|---|
| 33 | ----------------------------------------------------------------------- |
|---|
| 34 | |
|---|
| 35 | - A new contract was created with unique contract ID. |
|---|
| 36 | |
|---|
| 37 | - Any optional contract-add-ons can be booked for the new contract. |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | Incoming Data |
|---|
| 41 | ----------------------------------------------------------------------- |
|---|
| 42 | |
|---|
| 43 | - Customer ID, service ID, respective contractual parameters (like: |
|---|
| 44 | start of service, end of service, picked payment methods, etc.) |
|---|
| 45 | |
|---|
| 46 | Outgoing Data |
|---|
| 47 | ----------------------------------------------------------------------- |
|---|
| 48 | |
|---|
| 49 | - Message about contract creation. |
|---|
| 50 | - Log message |
|---|
| 51 | |
|---|
| 52 | |
|---|
| 53 | Precondition(s) |
|---|
| 54 | ----------------------------------------------------------------------- |
|---|
| 55 | |
|---|
| 56 | - Customer ID must exist and be valid for new contracts. |
|---|
| 57 | - Submitting user must be authorized to perform the operation. |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | Postcondition(s) |
|---|
| 61 | ----------------------------------------------------------------------- |
|---|
| 62 | |
|---|
| 63 | - The contractual parameters were checked for validity. |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | Invariant(s) |
|---|
| 67 | ----------------------------------------------------------------------- |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | Essential Steps |
|---|
| 71 | ----------------------------------------------------------------------- |
|---|
| 72 | |
|---|
| 73 | - System receives customer ID, service ID and any optional parameters |
|---|
| 74 | specifying the contract to create. |
|---|
| 75 | - Passed in service is requested to create a new contract with |
|---|
| 76 | passed-in parameters (contractual details) set (inludes validating |
|---|
| 77 | the passed in data). |
|---|
| 78 | - If passed-in parameters are invalid, user is offered a possibility |
|---|
| 79 | to fix the invalid data. |
|---|
| 80 | - System creates the new contract connecting it to the given |
|---|
| 81 | customer ID. |
|---|
| 82 | |
|---|
| 83 | |
|---|
| 84 | Open Issues |
|---|
| 85 | ----------------------------------------------------------------------- |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | Remarks |
|---|
| 90 | ----------------------------------------------------------------------- |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | .. raw:: latex |
|---|
| 94 | |
|---|
| 95 | \pagebreak[4] |
|---|
