Package com.priint.pubserver.entity

Class EntityMethod

  • All Implemented Interfaces:
    java.io.Serializable
    public class EntityMethod
extends java.lang.Object
implements java.io.Serializable
    The type Entity method.
    See Also:
    EntityMethodCall, Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      EntityMethod()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getAnnotation()
      Get list of method annotations.
      java.lang.String getDescription()
      Defaults to an empty string.
      java.lang.String getIdentifier()
      Method identifier is a system wide, unique name of the method.
      java.util.List<KeyValue> getParameter()
      Description of the parameters to use when calling the method.
      void setAnnotation​(java.util.List<java.lang.String> annotation)
      Set list of method annotations.
      void setDescription​(java.lang.String description)
      Throws NullArgumentException if input is null.
      void setIdentifier​(java.lang.String identifier)
      Throws NullArgumentException if input is null.
      void setParameter​(java.util.List<KeyValue> parameter)
      Throws NullArgumentException if input is null.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EntityMethod

        public EntityMethod()

    • Method Detail

      • getIdentifier

        public java.lang.String getIdentifier()
        Method identifier is a system wide, unique name of the method. E.g. "getKeyValueListOfSubentities"
        Returns:
        the identifier

      • setIdentifier

        public void setIdentifier​(java.lang.String identifier)

        Throws NullArgumentException if input is null.

        Parameters:
        identifier - the identifier

      • getAnnotation

        public java.util.List<java.lang.String> getAnnotation()
        Get list of method annotations.

        Defaults to an empty list.

        Returns:
        annotation annotation

      • setAnnotation

        public void setAnnotation​(java.util.List<java.lang.String> annotation)
        Set list of method annotations.

        Throws NullArgumentException if input is null.

        Parameters:
        annotation -

      • getParameter

        public java.util.List<KeyValue> getParameter()
        Description of the parameters to use when calling the method.
        • The KeyValue.key contains the name of the parameter.
        • The KeyValue.value contains the documentation.
        • The KeyValue.datatype contains the data type of the parameter.
        Defaults to an empty list.
        Returns:
        parameter as List of KeyValue

      • setParameter

        public void setParameter​(java.util.List<KeyValue> parameter)

        Throws NullArgumentException if input is null.

        Parameters:
        parameter -

      • getDescription

        public java.lang.String getDescription()

        Defaults to an empty string.

        Returns:
        description as String

      • setDescription

        public void setDescription​(java.lang.String description)

        Throws NullArgumentException if input is null.

        Parameters:
        description -