1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
.. Copyright 2019
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
Business Interaction Model
==========================
.. contents::
:depth: 3
..
Diagram
-------
Business Interaction
^^^^^^^^^^^^^^^^^^^^
.. image:: BusinessInteraction.png
Class Definition
----------------
BusinessInteractionItemRelationship class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
**Table** **Attributes for Class BusinessInteractionItemRelationship**
================== ========== ========= ===================================================== =====================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ========== ========= ===================================================== =====================
type String 1 The type of relationship such as contains, relies on. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
================== ========== ========= ===================================================== =====================
Agreement class
^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::Agreement
**Description:**
A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law.
**Parent class:** BusinessInteraction
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
**Table** **Attributes for class Agreement**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
documentNumber String 1 A reference number assigned to an Agreement that follows a prescribed numbering system. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
statementOfIntent String 1 An overview and goals of the Agreement. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
StartDate DateTime 1 Date interaction initiated OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute
Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
BusinessInteraction class
^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteraction
**Description:**
A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements.
This class is abstract.
**Parent class:** RootEntity
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
**Table** **Attributes for class BusinessInteraction**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
StartDate DateTime 1 Date interaction initiated OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute
Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== =====================
BusinessInteractionItem class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionItem
**Description:**
The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource.
This class is abstract.
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
**Table** **Attributes for class BusinessInteractionItem**
================== ======== ========= ======================================================================= =====================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ======== ========= ======================================================================= =====================
quantity Integer 1 Quantity of an interaction item involved in an interaction. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
action String 1 The action to take for an InteractionItem, such as add, change, remove. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
================== ======== ========= ======================================================================= =====================
BusinessInteractionRelationship class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship
**Description:**
An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement.
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
**Table** **Attributes for class BusinessInteractionRelationship**
================== ========== ========= =============================================================================== =====================
**Attribute Name** **Type** **Mult.** **Description** **Stereotypes**
================== ========== ========= =============================================================================== =====================
type String 1 A categorization of the relationship, such as bulk, parent/child, and so forth. OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute
- partOfObjectKey: 0
- uniqueSet:
- isInvariant: false
- unsigned: false
- counter: NA
- support: MANDATORY
Preliminary
================== ========== ========= =============================================================================== =====================
BusinessInteractionSpec class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionSpec
**Description:**
The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec.
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
BusinessInteractionVersion class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionVersion
**Description:**
Version of the business interaction.
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From TMF SID
Notification class
^^^^^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::Notification
**Description:**
A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction.
This class is abstract.
**Parent class:** BusinessInteraction
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From the TMF SID
Request class
^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::Request
**Description:**
The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction.
This class is abstract.
**Parent class:** BusinessInteraction
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From the TMF SID
Response class
^^^^^^^^^^^^^^
**Qualified Name:** Common::Business Interaction::ObjectClasses::Response
**Description:**
A reply to a Request
This class is abstract.
**Parent class:** BusinessInteraction
**Applied Stereotypes:**
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: From the TMF SID
|