Managed Entity Artifact

Description

An Managed Entity Artifact models a "thing" of physical or logical existence in an OSS/BSS system. An instance of a Managed Entity is uniquely identified by a key. Examples of Managed Entity Artifacts are Switches, Circuits, Customers, etc..

Modeling Details

Standard Modeling Details

Package: a valid package name.

Name: a unique name for this Entity within the scope defined by the package.

Super-Artifact (optional): the fully qualified name of the Entity being extended by this Entity definition. This is optional.

Artifact Specific Modeling Details

Entity Labels: labels to capture specific values within the scope of this Entity. As opposed to an Enumeration Artifact, the type of all the constants does not need to be identical.

Entity Methods: operations defined on the entity. For example, an typical operation on a Trouble Ticket Entity would be "escalate". This operation would result in a change of severity on the ticket. Generally speaking each method is turned into an operation on the generated Service Contract (ie. "escalateTroubleTicketByKey()" which would escalate a given TroubleTicket identified by its key).

Entity Fields: the set of fields that constitute this Entity Artifact. Each field shall be of a primitive type or of another Artifact type (to model References).

Generation Details

Standard Generation Details

Interface Package: the name of the package where the corresponding Java Interfaces shall be generated. If a default interface package has been set for the project, this value will be used by default.

Artifact Specific Generation details

Primary Key Type: the type for the primary key to be used in the generated code. By default, a String primary key will be used.
Single Extension Flag: in the J2EE profile factory methods are generated for every modeled Entity Artifact. In order for those to be optimized, the single extension flag can be set to true in case where the Managed Entity Artifact is only expected to be extended with a single artifact. The default value is set to false.

Generated Elements

As a result of defining a Managed Entity in a Tigerstripe Model, the following is generated:

J2EE Integration Profile: a set of Java Interfaces corresponding to the value type, the iterators, and the key for this entity.

JMS/XML Integration Profile: an xsd sequence corresponding to the value type for this Entity, a set of request/response/exception messages for all defined methods, and a set of xsd sequences for all corresponding iterators.

Web Service Integration Profile: the xml definition from the JMS/XML profile is reused directly.