Package com.smeup.kokos.sdk.entity.annotations

Annotation Interface SmeupObj

@Retention(RUNTIME) @Target(TYPE) public @interface SmeupObj
Marks a class as a Smeup object entity and binds it to a Smeup class key.

Type (class key)

In the Smeup object model every object is identified by a class key formed by a 2-character type and an optional parameter concatenated together (e.g. type "CN" + parameter "COL" → class key "CNCOL").

Role in the SDK

This annotation is the binding contract between a Java class and its Smeup identity. It is used for instance by

invalid reference 
com.smeup.kokos.service.KS_202_01E
(and any other component that receives a type+parameter pair from a FUN) to resolve the correct registered entity class from the global EntityManager — regardless of how the Java class is named.

Usage


 // class key "CNCOL" (contact collaborator)
 @SmeupObj(type = "CNCOL", description = "Employee")
 public class CustomerCollaborator extends AbstractEntity { ... }

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
     
    String
    type
    Smeup class key: 2-char type + optional parameter (e.g.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    authService
     

  • Element Details

    • type

      String type
      Smeup class key: 2-char type + optional parameter (e.g. "CNCOL").

    • description

      String description

    • authService

      String authService
      Default:
      ""