Enum ViewServiceDescription

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ViewServiceDescription>

    public enum ViewServiceDescription
    extends java.lang.Enum<ViewServiceDescription>
    implements java.io.Serializable
    ViewServiceDescription provides a list of registered view services.
    • Method Detail

      • values

        public static ViewServiceDescription[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ViewServiceDescription c : ViewServiceDescription.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ViewServiceDescription valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getViewServiceDefinition

        public static ViewServiceDescription getViewServiceDefinition​(int viewServiceCode)
        Return the enum that corresponds with the supplied code.
        Parameters:
        viewServiceCode - requested code
        Returns:
        enum
      • getViewServiceCode

        public int getViewServiceCode()
        Return the code for this enum instance
        Returns:
        int type code
      • getViewServiceDevelopmentStatus

        public ComponentDevelopmentStatus getViewServiceDevelopmentStatus()
        Return the development status of the component.
        Returns:
        enum describing the status
      • getViewServiceName

        public java.lang.String getViewServiceName()
        Return the default name for this enum instance.
        Returns:
        String default name
      • getViewServiceFullName

        public java.lang.String getViewServiceFullName()
        Return the formal name for this enum instance.
        Returns:
        String default name
      • getViewServiceURLMarker

        public java.lang.String getViewServiceURLMarker()
        Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
        Returns:
        String default name
      • getViewServiceDescription

        public java.lang.String getViewServiceDescription()
        Return the default description for the type for this enum instance.
        Returns:
        String default description
      • getViewServiceWiki

        public java.lang.String getViewServiceWiki()
        Return the URL for the wiki page describing this UI view.
        Returns:
        String URL name for the wiki page