Package org.odpi.openmetadata.adminservices.configuration.registration

Enum Class ViewServiceDescription

java.lang.Object
java.lang.Enum<ViewServiceDescription>
org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceDescription
All Implemented Interfaces:
Serializable, Comparable<ViewServiceDescription>, Constable
public enum ViewServiceDescription extends Enum<ViewServiceDescription> implements Serializable
ViewServiceDescription provides a list of registered view services.

  • Enum Constant Details

  • Method Details

    • values

      public static ViewServiceDescription[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ViewServiceDescription valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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 String getViewServiceName()
      Return the default name for this enum instance.
      Returns:
      String default name

    • getViewServiceFullName

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

    • getViewServiceURLMarker

      public 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 String getViewServiceDescription()
      Return the default description for the type for this enum instance.
      Returns:
      String default description

    • getViewServiceWiki

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