Package com.ptc.windchill.annotations.metadata

Annotation Interface MyRole

@Retention(CLASS) @Target({}) @Documented public @interface MyRole
A role descriptor for the non-aggregated -- non one/zero-to-one -- side of a foreign key association. Note that if you're constraining an existing link, you should not need to specify this role at all, as the default values for each of this annotation's properties will cause it to automatically pick up the parent role's properties.

Supported API: true

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    PropertyAccessors
    accessors
    Controls the accessibility and exceptions for generated accessor methods.
    Cardinality
    cardinality
    The cardinality of this particular role.
    boolean
    cascade
    Indicates whether deletes should cascade.
    String
    javaDoc
    A string representing the JavaDoc to generate for this property.
    String
    name
    The name of this role.
    SupportedAPI
    supportedAPI
    The supported nature of this property to be generated into your marvelous JavaDoc .

  • Element Details

    • name

      String name
      The name of this role. Use the default value if you're constraining an existing association to retain its role name.

      Rose conversion note: Corresponds to Association Specification -> General -> Role A/B.

      Supported API: true

      Default:
      ""

    • javaDoc

      String javaDoc
      A string representing the JavaDoc to generate for this property. Leave blank only if you want to reuse the parent role's JavaDoc.

      Rose conversion note: Corresponds to Association Specification -> Role A/B General -> Documentation.

      Supported API: true

      See Also:
      Default:
      ""

    • supportedAPI

      SupportedAPI supportedAPI
      The supported nature of this property to be generated into your marvelous JavaDoc .

      Rose conversion note: Corresponds to Association Specification -> Windchill A/B -> SupportedAPI.

      Supported API: true

      Default:
      PRIVATE

    • cardinality

      Cardinality cardinality
      The cardinality of this particular role. The default (Cardinality.DEFAULT) indicates that the parent role's multiplicity should be used (if no parent exists, defaults to Cardinality.MANY).

      Rose conversion note: Corresponds to Association Specification -> Role A/B Detail -> Multiplicity.

      Supported API: true

      Default:
      DEFAULT

    • cascade

      boolean cascade
      Indicates whether deletes should cascade. If set to true, the persistence layer will attempt to delete this object when the object it's referring to in this foreign key reference is deleted; if set to false and the object being referred to is successfully deleted, the reference will be nulled out.

      If unspecified, uses the parent's value or false if no parent.

      Rose conversion note: Corresponds to Association Specification -> Windchill A/B -> Cascade.

      Supported API: true

      Default:
      false

    • accessors

      PropertyAccessors accessors
      Controls the accessibility and exceptions for generated accessor methods. If unspecified, uses parent's role or @PropertyAccessors if no parent. This property corresponds to the accessors generated for the foreign key link class (resembling a binary link) that's automatically generated when a foreign key is generated; it does not correspond to the accessors generated on the persistable itself (see ForeignKeyRole).

      Rose conversion note: Corresponds to various properties found in Association Specification -> Windchill A/B.

      Supported API: true

      Default:
      @com.ptc.windchill.annotations.metadata.PropertyAccessors