Enum AccessServiceDescription

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

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

      • values

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

        public static AccessServiceDescription 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
      • getAccessServiceDefinition

        public static AccessServiceDescription getAccessServiceDefinition​(int accessServiceCode)
        Return the enum that corresponds with the supplied code.
        Parameters:
        accessServiceCode - requested code
        Returns:
        enum
      • getAccessServiceCode

        public int getAccessServiceCode()
        Return the code for this enum instance
        Returns:
        int type code
      • getAccessServiceDevelopmentStatus

        public ComponentDevelopmentStatus getAccessServiceDevelopmentStatus()
        Return the development status of the service.
        Returns:
        enum describing the status
      • getAccessServiceName

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

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

        public java.lang.String getAccessServiceURLMarker()
        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 URL marker
      • getAccessServiceDescription

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

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