...
It contains the following attributes:
...
- bulkTransferPattern : This attribute allows the selection of the bulk data transfer implementation style. This is applicable when at least one of the parameter's isBulkPotential attribute of the tipParameter stereotype is set to true. Possible
...
- values :
- FILE FILE : this operation uses a file transfer pattern for bulk attributes. This is not implemented in JOSIF V1.0 or in JOSIF V1.1.
- ITERATOR ITERATOR : this operation uses an iterator transfer pattern for bulk attributes. This pattern is described in the general patterns (General_Patterns#Interaction_Patterns).
- NONE (default) : this operation does not require any bulk transfer pattern.
Panel
- emitEvents : This attribute indicates the capability of the Target OS operation to emit event notifications. If checked, the operation can emit progress events. The events that can be emitted are listed under the emittedEvents attribute. The event type that better matches the operation process tracking capability must be selected. The operation response (if any defined) shall be returned as soon as it is validated by the Target OS. Boolean attribute with default being false. *
- emittedEvents : This attribute lists the events that can be emitted by the operation. It is a list of event names, separated by commas. The event names should be valid events defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myEvent should be used. Array of Strings.
- *isExtendable : Indicates if the operation is extendable. Extensibility is described in the general patterns (General_Patterns#Extensibility). Boolean attribute with default being false. *
- isIdempotent : Indicates if checked, that the operation can be repeated provided the same result every time. Boolean attribute with default being false.
- *isOneWay : This attribute indicates that the operation is either an input or an output with respect to the service interface. The operation is an input oneWay if it has only input parameters. It is an output oneWay if it has only output parameters. Boolean attribute with default being false. *
- support : This property indicates whether the identified operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. Possible values:
- O O : Optional (default).
- M M : Mandatory
tipParameter
This stereotype provides the enhanced definitions for parameters that are relevant for application in a TM Forum interface.
It contains the following attributes:
...
...
- isBulkPotential : This attribute indicates that this parameter can potentially be a very large collection, which will require a bulk data transfer patern implementation. Atomic definition (unit) is based on the parameter's associated data type. The selection of the bulk data transfer is defined using the tipOperation stereotype bulkTransferPattern attribute. Boolean attribute with default being false.
...
- passedById : Indicate if a parameter is passed by Id (True) or by value (False). If passed by Id, then only an EntityId will be passed, otherwise the whole object will be provided. Boolean attribute with default being false.
...
- support : This property indicates whether the identified parameter must be represented in TIP interface or not. If the parameter is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. Possible values:
- O O : Optional (default).
- M M : Mandatory
tipNotification
...
It contains the following attributes:
...
...
- support : This property indicates whether the identified notification must be represented in TIP interface or not. If the notification is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. Possible values:
- O O : Optional (default).
- M M : Mandatory
Common Operation Stereotypes
In JOSIF V1.1, new stereotypes have been added for the Common Operations. These stereotypes are used to generate automatically, if applicable, create, delete, get and set operations. This is further explained in General _ Patterns#Common Operations.
The stereotypes defined in TIP for common operations are:
...
...
- tipEntityCreate for the common create operation
...
- tipEntityDelete for the common delete operation
...
- tipEntityGet for the common get operation on a single object
...
- tipEntityGetMultipe for the common get operation on multiple objects using a filter
...
- tipEntitySet for the common set operation on a single object
...
- tipEntitySetMultipe for the common set operation on multiple objects using a filter
tipEntityCreate
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the common create directive. Assuming this stereotype is applied on the Thing entity artifact, it will define the operation createThing in any service interface having Thing as managed entity. This is further explained in in General _ Patterns#Common Operations.
It contains the following attributes:
...
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- isExtendable : This attribute indicates if the operation is extendable. It is equivalent to the isExtendable attribute of the tipOperation stereotype. Boolean attribute with default being false.
...
- support : This property indicates whether the create operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default).
- M M : Mandatorypanel*
- useAutoNaming : This attribute indicates if the operation uses auto-naming for the creation of the identifier. extendable. If true, the id of the object will be provided by the server and must not be provided by the client. Boolean attribute with default being false.
tipEntityDelete
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the common delete directive. Assuming this stereotype is applied on the Thing entity artifact, it will define the operation deleteThing in any service interface having Thing as managed entity. This is further explained in in General _ Patterns#Common Operations.
It contains the following attributes:
...
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- support : This property indicates whether the delete operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default).
- M M : Mandatorypanel
tipEntityGet
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the single instance common get directive. It allows getting the values of a single instance. Assuming this stereotype is applied on the Thing entity artifact, it will define the operation getThing in any service interface having Thing as managed entity. This is further explained in General _ Patterns#Common Operations.
It contains the following attributes:
...
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- support : This property indicates whether the get operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default).
- M M : Mandatory
tipEntityGetMultiple
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the multiple instances common get directive. It allows getting all the entities matching a filter, returning either the ids or the values. Assuming this stereotype is applied on the Thing entity artifact, it will define either the operation getThings or getThingIds or both in any service interface having Thing as managed entity. This is further explained in General _ Patterns#Common Operations.
It contains the following attributes:
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- filteringType : This attribute indicates the type of filter supported by the operation. 2 styles of filtering are possible. Template-based filtering uses a combination of attributes of the entity. Query-based filtering uses an xpath query. Possible
...
- values :
- template template : uses template-based filtering (Default)
- template + query query : Provides a choice of template or query filtering. Each instance of a get request might use a different form of filteringpanel*
- getType : This attribute indicate what get operations should be generated: the one returning the object values, the one returning the object ids, or both operations. If both get operations are selected, then the other attributes of the stereotype (description, support, exceptions) are applicable to each one of the 2 operations. Possible values values :
- both : provides both
- GetThingIds and GetThings to return the Thing objects matching the criteria by id or value (Default)
- id : defines a
- GetThingIds operation returning the Thing objects matching the criteria by identifier
- value : defines a
- GetThings operation returning the Thing objects matching the criteria by value
- *support : This property indicates whether the get operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default)
- M M : Mandatory
tipEntitySet
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the single instance common set directive. It allows setting a single instance where all attributes should be set in an atomic way. Assuming this stereotype is applied on the Thing entity artifact, it will define the operation setThing in any service interface having Thing as managed entity. This is further explained in General _ Patterns#Common Operations.
It contains the following attributes:
...
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- isExtendable : This attribute indicates if the operation is extendable. It is equivalent to the isExtendable attribute of the tipOperation stereotype. Boolean attribute with default being false.
...
- support : This property indicates whether the set operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default).
- M M : Mandatory
tipEntitySetMultiple
Only in JOSIF V1.1.
This stereotype defines the configuration information needed for the multiple instances common set directive. It allows setting all entities matching a filter. Assuming this stereotype is applied on the Thing entity artifact, it will define either the operation setThings or setThingsAtomic in any service interface having Thing as managed entity. This is further explained in General _ Patterns#Common Operations.
It contains the following attributes:
...
...
- description : This attribute provides the description of the directive that will be used in the documentation. String datatype.
...
- exceptions : This attribute lists all the specific exceptions for this directive. The exception names should be valid exceptions defined in the model. Fully qualified event names in form org.tmforum.tip.service.problem.myException should be used. These exceptions are additional to the pre-defined exceptions and the common exceptions defined as default for this operation. Array of Strings.
...
- filteringType : This attribute indicates the type of filter supported by the operation. 2 styles of filtering are possible. Template-based filtering uses a combination of attributes of the entity. Query-based filtering uses an xpath query. Possible
...
- values :
- template template : uses template-based filtering (Default)
- template + query query : Provides a choice of template or query filtering. Each instance of a get request might use a different form of filteringpanel*
- isAtomic : This attribute defines if the set on multiple instances will use the atomic form (setThingsAtomic) or not (setThings). Boolean attribute with default being false. *
- isExtendable : This attribute indicates if the operation is extendable. It is equivalent to the isExtendable attribute of the tipOperation stereotype. Boolean attribute with default being false.
- *support : This property indicates whether the set operation must be represented in TIP interface or not. If the operation is required to be represented in all cases then the value should be set to "M" (Mandatory) otherwise it should be set to "O" (Optional) indicating that a choice will be made on some other basis at some other point in the process. It is equivalent to the support attribute of the tipOperation stereotype. Possible values:
- O O : Optional (default)
- M M : Mandatory
Primitives datatypes
...
TIP defines the following primitives datatypes:
...
- any : allow at implementation level to be replaced by any datatype.
...
- boolean
...
- byte
...
- char
...
- date
...
- double
...
- float
...
- int
...
- long
...
- objectName : will be replaced at interface level by an EntityIdentifier (please refer to Internal_Framework_Model#Entity_Identifier) allowing to input any entity. When the entity to provide has a known type, then an explicit association should be preferred.
...
- short
...
- String : not that in Tigerstripe, this is String with a capital S.
...
- time : correspond to ITU-T time.
...
- unknown : this datatype should not be directly used in models. It wil lbe present in Tigerstripe models if an unknown RSM datatype is used. In this case, it will be replaced by this unknown datatype. Note that generators will fail and stop with an explicit error when meeting such datatype in a model.
...
- void : only present as return type for operations. In TIP, all operations return void and use output parameters to return data. Please refer to Interface_Meta-Model for details.