Enum CommonServicesDescription

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

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

      • values

        public static CommonServicesDescription[] 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 (CommonServicesDescription c : CommonServicesDescription.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CommonServicesDescription 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
      • getGovernanceServersDescriptionList

        public static java.util.List<CommonServicesDescription> getGovernanceServersDescriptionList()
        Return a list containing each of the access service descriptions defined in this enum class.
        Returns:
        List of enums
      • getServiceCode

        public int getServiceCode()
        Return the code for this enum instance
        Returns:
        int type code
      • getServiceDevelopmentStatus

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

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

        public java.lang.String getServiceURLMarker()
        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
      • getServiceDescription

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

        public java.lang.String getServiceWiki()
        Return the URL for the wiki page describing this access service.
        Returns:
        String URL for the wiki page