TIP JOSIF Main Page |TIP JOSIF Framework |TIP Doc Generator | TIP Doc Generator Doc Structure
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Terminology and Convention
...
The content of the notice is give at tigerstripe.xml of the model project.
| Code Block |
|---|
Copyright 2010 TM Forum
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an 'AS IS' BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
...
Following is the outline of this chapter.
| Code Block |
|---|
3. Information Model
${a paragraph gives list of packages}
3.1. Package ${fully qualified name of 1st package}
${properties and picture of the session facase}
3.1.1. Entities
3.1.1.1. ${short name of 1st entity}
${summary of the entity}
3.1.1.1.1. Attributes
${a table which describes all attributes (local or inherited) of the entity}
3.1.1.2. ${short name of 2nd entity}
${summary of the entity}
3.1.1.1.1. Attributes
${a table which describes all attributes (local or inherited) of the entity}
3.1.1.1.2. Associations
${a table which describes all associations (local or inherited) of the entity}
3.1.1.3. ...
3.1.2. Association Classes
3.1.2.1. ${short name of 1st association class}
${summary of the association class}
3.1.2.1.1. Ends
${a table which describes all ends of the association class}
3.1.2.1.2. Attributes
${a table which describes all attributes (local or inherited) of the association class}
3.1.2.2. ...
3.1.3. Data Types
3.1.3.1. ${short name of 1st datatype}
${summary of the datatype}
3.1.3.1.1. Attributes
${a table which describes all attributes (local or inherited) of the datatype}
3.1.3.2. ${short name of 2nd datatype}
${summary of the datatype}
3.1.3.2.1. Attributes
${a table which describes all attributes (local or inherited) of the datatype}
3.1.3.3. ...
3.1.4. Exceptions
3.1.4.1. ${short name of 1st exception}
${summary of the exception}
3.1.4.1.1. Attributes
${a table which describes all attributes (local or inherited) of the exception}
3.1.4.2. ${short name of 2nd exception}
${summary of the exception}
3.1.4.2.1. Attributes
${a table which describes all attributes (local or inherited) of the exception}
3.1.4.3. ...
3.1.5. Notifications
3.1.5.1. ${short name of 1st notification}
${summary of the notification}
3.1.5.1.1. Attributes
${a table which describes all attributes (local or inherited) of the notification}
3.1.5.2. ${short name of 2nd notification}
${summary of the notification}
3.1.5.2.1. Attributes
${a table which describes all attributes (local or inherited) of the notification}
3.1.5.3. ...
3.1.6. Enumerations
3.1.6.1. ${short name of 1st enumeration}
${summary of the enumeration}
3.1.6.1.1. Literals
${a table which describes all literals(local) of the enumeration}
3.1.6.2. ${short name of 2nd notification}
${summary of the enumeration}
3.1.6.2.1. Literals
${a table which describes all literals(local) of the enumeration}
3.1.6.3. ...
|
...
At the very beging of the chapter, we give a list of all packages which are available from the service and non-empty (i.e. contains at least one artifact of following type: entity, datatype, association, association class, exception, enumeration, and notification). The pattern of the paragraph is:
| Code Block |
|---|
List of packages which are available from ${serviceName} and contain artifacts:
- ${short name of 1st package with a link to corresponding section entitled the short name}
- ${short name of 2nd package with a link to corresponding section entitled the short name}
- ...
|
If no such package available in the TIP Model, the paragraph reads
| Code Block |
|---|
no packages available from ${serviceName}.
|
Here is a sample from document of TIP SPM Model.
| Code Block |
|---|
List of packages which are available from Service Problem Management and contain artifacts:
- org.tmforum.tip.cbe.problem
- org.tmforum.tip.service.problem
|
...
Pattern of the summary:
| Code Block |
|---|
- Type: Entity Artifact
- Package: ${fully qualified name of package of entity}
- All super types:
${firstSuperType}
${secondSuperType}
....
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
isMandatory = ${value of tipClass:support}
isExtendable = true
objectCreationNotification = ${value of tipClass:objectCreationNotification}
objectDeletionNotification = ${value of tipClass:objectDeletionNotification}
objectDiscoveryNotification = ${value of tipClass:objectDiscoveryNotification}
${picture of the entity}
|
...
- the 3rd cell of the row is a list properties, its pattern is (please refer to "display rules" for more details):
| Code Block |
|---|
typeMultiplicity = ${multiplicity of the argument}
isReadonly = ${value of isReadonly}
isOrdered = ${value of isOrdered}
isUnique = ${value of isUnique}
default value = ${default value of the attribute}
isInvariant = ${value of tipAttribute:isInvariant}
notificationDefinition = ${value of tipAttribute:notificationDefinition}
passedById = ${value of tipAttribute:passedById}
support = ${value of tipAttribute:support}
|
...
- the 3rd cell of the row is a list properties, its pattern is (please refer to "display rules" for more details):
| Code Block |
|---|
multiplicity = ${multiplicity of the end}
aggregation = ${value of aggregation}
isNavigable = ${value of isNavigable}
isOrdered = ${value of isOrdered}
isUnique = ${value of isUnique}
isInvariant = ${value of tipAttribute:isInvariant}
notificationDefinition = ${value of tipAttribute:notificationDefinition}
passedById = ${value of tipAttribute:passedById}
support = ${value of tipAttribute:support}
association = ${short name of association to which the end belongs}
|
...
Pattern of association class summary:
| Code Block |
|---|
- Type: Association Class Artifact
- Package: ${fully qualified name of package}
- All super types:
${a list of supertypes}
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
support = ${value of tipAssociationClass:support}
objectCreationNotification = ${value of tipClass:objectCreationNotification}
objectDeletionNotification = ${value of tipClass:objectDeletionNotification}
objectDiscoveryNotification = ${value of tipClass:objectDiscoveryNotification}
|
...
Pattern of datatype summary:
| Code Block |
|---|
- Type: Datatype Artifact
- Package: ${fully qualified name of package}
- All super types:
${a list of supertypes}
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
isExtendable = ${value of tipDatatype:isExtendable}
|
...
Pattern of exception summary:
| Code Block |
|---|
- Type: Exception Artifact
- Package: ${fully qualified name of package}
- All super types:
${list of super types}
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
|
...
Pattern of notification summary:
| Code Block |
|---|
- Type: Event Artifact
- Package: ${fully qualified name of package}
- All super types:
${list of super types}
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
support = ${value of tipNotification:support}
|
...
Pattern of enumeration summary:
| Code Block |
|---|
- Type: Enumeration Artifact
- Package: ${fully qualified name of package}
- All super types:
${list of super types}
- Description: ${description}
- Properties:
isAbstract = ${value of isAbstract}
isExtendable = ${value of tipDatatype:isExtendable}
|
...
- the 3rd cell of the row is a list properties, its pattern is:
| Code Block |
|---|
value = ${value of literal}
|
...
Outline of this chapter ....
| Code Block |
|---|
4. Service Interfaces
${a paragraph gives list of service interfaces}
4.1 ${short name of 1st session facade}
${properties and picture of the session facase}
4.1.1 ${short name of the 1st operation in the session facade}
4.1.1.1 Arguments
${a table which describes all arguments of the operation}
4.1.2 ${short name of the 2nd operation in the session facade}
4.1.1.2 Arguments
${a table which describes all arguments of the operation}
4.1.3 ...
4.2 ${short name of 2nd session facade}
....
|
...
In very beging of the chapter, we give a list of all service interfaces available from the service. The pattern of the paragraph is:
| Code Block |
|---|
List of service interfaces available from ${serviceName}:
- ${short name of 1st session facade with a link to corresponding section entitled the short name}
- ${short name of 2nd session facade with a link to corresponding section entitled the short name}
- ...
|
If no service facade available in the TIP Model, the paragraph reads
| Code Block |
|---|
no service interface available from ${serviceName}.
|
Here is a sample from document of TIP SPM Model.
| Code Block |
|---|
List of service interfaces available from Service Problem Management:
- ProblemInterface
- ServiceProblemInterface
|
...
summary of an interface
Pattern:
| Code Block |
|---|
- Type: Session Artifact
- Package: ${the package of the session facade and a link to a section which gives details of the package (and enclosed artifacts)}
- Description: ${description of the session facade}
- Services exposed:
${list of short names of local methods and links to sub-sub-sections which give details of the methods}
- Managed entities:
${entities managed by the session facade and links to sections which give details of the entities}
- Properties:
isAbstract = ${the value of isAbstract}
${picture of the session facade}
|
...
Pattern of method summary (refer to "display rules" for more details):
| Code Block |
|---|
- Description: ${description}
- Properties:
visibility = ${value of visiblity}
isAbstract = ${value of isAbstract}
support = ${value of tipOperation:support}
isIdempotent = ${value of tipOperation:isIdempotent}
bulkTransferPattern = ${value of tipOperation:bulkTransferPattern}
emitEvents = ${value of tipOperation:emitEvents}
isOneWay = ${value of tipOperation:isOneWay}
isExtendable = ${value of tipOperation:isExtendable}
- Return:
${return}
- Exceptions:
${list of short names of declared exceptions with links}
${list of short names of pre-defined exceptions with links}
|
...
- the 3rd cell of the row is a list properties, its pattern is (refer to "display rules" for more details):
| Code Block |
|---|
typeMultiplicity = ${multiplicity of the argument}
direction = ${direction of the argument}
passedById = ${value of tipParameter:passedById}
isBulkPotential = ${value of tipParameter:isBulkPotential}
support = ${value of tipParameter:support}
defaut value = ${default value of the argument}
isOrdered = ${value of isOrdered}
isUnique = ${value of isUnique}
|
...