Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Service Interfaces

Operations are grouped in in Service Interfaces that are named Session Facade in Tigerstripe. An interface specification must have at least one Service Interface, but having more than one is possible if needed by the design of the interface. Please use the stereotype stereotype tipServiceInterfaceto indicate if the implementation of the service interface is mandatory or not.

For entity-centric interfaces centered around one object, like Service Problem or TroubleTicket, the recommendation is to name the main Service
Interface <Object>Interface. For example, ServiceProblemInterface in case of SPM where the main object is the Service Problem. For these entity-centric interfaces, if some common operations, like create, delete, get or set are needed, then it might be worth considering using the Common Operations pattern. This pattern is used by defining the needed tipEntityXxx stereotype on the corresponding entity artefact. If for any reason, this pattern is not suitable for interface, then defining explicitly the needed operation is possible. It is however recommended to try to follow as much as possible the signature of the corresponding common operation for consistency.

Operations

All  TIP operations should Operations should return void.
Do not forget to add and document the the tipOperation stereotype  stereotype on each operation.
Add needed parameters with corresponding tipParameter stereotype stereotype.

Pre-defined exceptions are Exceptions are added to all operations. Any common exceptions can  Common Exceptions can be added and specific exceptions might be added as needed.

...

The TIP Framework generators will generate for each class the appropriate notifications based on the stereotypes defined for the objects. Please refer to the Notification general patternGeneral Pattern for more details on common notification.

It is also possible to define explicit notifications in the model using the the Notification artefact.

Validating the Model

...

These projects must be created by the TIP_ JOSIF Project _ Creator for  for getting correct settings.

...