Interface IParameter


  • public interface IParameter

    A parameter for a command. A parameter identifies a type of information that the command might accept. For example, a "Show View" command might accept the id of a view for display. This parameter also identifies possible values, for display in the user interface.

    Since:
    3.1
    • Method Detail

      • getId

        String getId()
        Returns the identifier for this parameter.
        Returns:
        The identifier; never null.
      • getName

        String getName()
        Returns the human-readable name for this parameter.
        Returns:
        The parameter name; never null.
      • isOptional

        boolean isOptional()
        Returns whether parameter is optional. Otherwise, it is required.
        Returns:
        true if the parameter is optional; false if it is required.