Package sk.ipesoft.d2000.d2japi.annotations.eventBinding

Annotation Type RPC


  • @Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface RPC
    Indicate that annotated method is used as D2000 RPC.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Indicate formal name of RPC.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean asynchronous
      Indicate that RPC is either synchronous or asynchronous.
      ConversationBeginType conversationBegin
      Indicate that RPC is used to begin RPC conversation.
      boolean conversationEnd
      Indicate that RPC is used to end RPC conversation.
      java.lang.String interfaceName
      Indicate that RPC is implementation of RPC defined in named ESL Interface object.
      Parameter[] parameters
      Indicate formal parameters of RPC.
      boolean useJava
      Indicate whether RPC is implemented in D2000 internal Java (true) or in ESL (false) or in JAPI Session (false).

    • Element Detail

      • name

        java.lang.String name
        Indicate formal name of RPC.

        Name must conform to D2000 rules for identifiers.

        Returns:
        formal name of RPC

      • asynchronous

        boolean asynchronous
        Indicate that RPC is either synchronous or asynchronous.
        Returns:
        true if the RPC is asynchronous
        Default:
        false

      • conversationBegin

        ConversationBeginType conversationBegin
        Indicate that RPC is used to begin RPC conversation.

        Only asynchronous RPCs of EventProxies and EventWrappers are allowed to begin RPC conversations.

        Returns:
        type of conversation begin
        Default:
        sk.ipesoft.d2000.d2japi.annotations.ConversationBeginType.none

      • conversationEnd

        boolean conversationEnd
        Indicate that RPC is used to end RPC conversation.

        Only asynchronous RPCs of ConversationContexts and ConversationHandlers are allowed to end RPC conversation.

        Returns:
        true if method ends RPC Conversation
        Default:
        false

      • interfaceName

        java.lang.String interfaceName
        Indicate that RPC is implementation of RPC defined in named ESL Interface object. Empty name indicates that no ESL Interface is involved.

        Only RPCs of EventProxies and ConversationsContexts implemented in ESL are allowed to implement RPCs defined in ESL Interfaces.

        Returns:
        formal name of ESL interface
        Default:
        ""

      • parameters

        Parameter[] parameters
        Indicate formal parameters of RPC.
        Returns:
        list of formal parameters
        Default:
        {}

      • useJava

        boolean useJava
        Indicate whether RPC is implemented in D2000 internal Java (true) or in ESL (false) or in JAPI Session (false).
        Returns:
        true if RPC is implemented in internal JAVA
        Default:
        false