JOSIF Main Page | JOSIF Guidebook | Modeling | General Patterns
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
The patterns listed in this section are part of the current JOSIF version. For a description of the patters planned for future versions, see General Patterns - Future.
...
The top level stereotypes defined in TIP are:
...
- tipClass for Entities
...
- tipDatatype for Datatypes
...
- tipAttribute for Attributes of Entitities and Association ends
...
- tipAssociationClass for Association Classes
...
- tipPackage for Packages
...
- tipServiceInterface for Service Interfaces
...
- tipOperation for Operations
...
- tipParamter for Parameters of Operations
...
- tipNotification for Notifications
The detailed attributes of each stereotype are describes in the TIP Profile section.
...
Extensibility is provided through the attribute extensionInfo.
This attribute has a datatype Any that is described in Internal_Framework_ModelModel#Extensibility. Note that this datatype is different from the primitive any datatype, as it includes a list of any.
...
- A sequential retrieval of the dataset by iteration-style of data batches (pages) from the first to the last one
- A more controlled retrieval of the dataset to support a pagination-style navigation through the dataset.
In the Interface Meta-Model (TIP Meta-Model), an operation is explicitly identified using the Iterator Pattern when:
...
- The Interface Meta-Model#Operation is marked with
...
- bulkTransferPattern set with ITERATOR, and
- At least, one Interface Meta-Model#Parameter is marked with the
...
- isBulkPotential and its multiplicity must allow more than a single instance (array of data).
Iterator Implicit Model Definitions
...
Its Tigerstripe model includes the following operation definitions using the Iterator interaction pattern.
The below settings define the output parameter objects as an array of ServiceProblem entity instances that can be retrieved using an iterator because it has the potential to be bulk:
...
- TIP service interface:
...
- ServiceProblemInterface
- Operation: getServiceProblemsByTemplate
...
- tipOperation stereotype:
- bulkTransferPattern = ITERATOR
- Argument:
- Name: objects
- Type: org.tmforum.tip.service.problem.ServiceProblem
- Multiplicity:
- 0..*
- Direction:
- out
- tipParameter stereotype:
- passedById is not set (Entity instances are to be returned as an array).
- isBulkPotential is set (Need for an iterator associated with this array of entity data).
- tipOperation stereotype:
Iterator Protocol Specific
- Refer to the TIP Framework TIP_Soap_Generator sub-project for XML mapping rule details - TIP_Soap_Generator_Mapping_Rules_-_Part_VI_VI#tipOperation___BulkTransferPattern_-_Iterator
Notifications
TIP defines a common parent for all TIP Notifications. It is called NotificationBase and shown in orange on the figures below. This type is injected by the TIP Generators into code generated from Tigerstripe Event (i.e. notification) artifacts where the 'Extends' field has been left as an empty string. It includes 1 attribute: sourceTime. Please refer to Internal Framework Model#Notifications for details.
...