Package com.priint.pubserver.plugin.annotation

Annotation Type PubServerMethodParameter

  • @Target(PARAMETER)
@Retention(RUNTIME)
public @interface PubServerMethodParameter
    Declares a parameter for a Publishing Server method.

    Arguments of annotated with PubServerMethodParameter will be visible in ison for project configuration.
    Expects the method itself is annotated as PubServerMethod.

    An example: 

     @PubServerMethodParameter(
   name = "texts", 
   defaultValue="", 
   description="text list as result from selected querymethod in dataprovider"
   ) List texts

    • Element Detail

      • name

        java.lang.String name
        Returns:
        name of the argument as it will be visible in clients
        Default:
        ""

      • defaultValue

        java.lang.String defaultValue
        Returns:
        default value of the argument as it will be visible in clients
        Default:
        ""

      • description

        java.lang.String description
        Returns:
        description of the argument as it will be visible in clients
        Default:
        ""

      • listOfValues

        java.lang.String[] listOfValues

        List of values applicable for this parameter

        List of values applicable for this parameter.
        If listOfValues() is non empty, client applications are supposed to use one of the values of this array (e.g. by showing a popup instead of text input field for parameter values).
        If defaultValue() is also set (i.e. non empty), this value should be preselected.

        Returns:
        list of values applicable for this parameter.
        Default:
        {""}

      • source

        PubServerMethodParameter.Source source

        Source for this parameter.

        Source for this parameter. Source is a hint for client application, whether this parameter is configurable for users or is calculated by the application.

        Returns:
        source for this parameter
        Default:
        com.priint.pubserver.plugin.annotation.PubServerMethodParameter.Source.USER

      • value

        Value value

        Value for this parameter.

        Value for this parameter. Value is a hint for client application, it contains list of default ValueItem. Client applications are supposed to use one of the values

        Returns:
        Value for this parameter
        Default:
        @com.priint.pubserver.plugin.annotation.Value(type=com.priint.pubserver.plugin.annotation.Value.Type.UNDEFINED)

      • conjunction

        PubServerMethodParameter.Conjunction conjunction

        Conjunction (Logical criteria) between search parameters

        It is for the find statements to build "search relationship" between search parameters.

        Default:
        com.priint.pubserver.plugin.annotation.PubServerMethodParameter.Conjunction.OR