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

Enum ViewServiceDescription

java.lang.Object

java.lang.Enum<ViewServiceDescription>

org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceDescription

All Implemented Interfaces:

Serializable, Comparable<ViewServiceDescription>

public enum ViewServiceDescription
extends Enum<ViewServiceDescription>
implements Serializable

ViewServiceDescription provides a list of registered view services.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DINO
GLOSSARY_AUTHOR
REPOSITORY_EXPLORER
SERVER_AUTHOR
TYPE_EXPLORER

Method Summary

Modifier and Type	Method	Description
int	getViewServiceCode()	Return the code for this enum instance
static ViewServiceDescription	getViewServiceDefinition(int viewServiceCode)	Return the enum that corresponds with the supplied code.
String	getViewServiceDescription()	Return the default description for the type for this enum instance.
ComponentDevelopmentStatus	getViewServiceDevelopmentStatus()	Return the development status of the component.
String	getViewServiceFullName()	Return the formal name for this enum instance.
String	getViewServiceName()	Return the default name for this enum instance.
String	getViewServiceURLMarker()	Return the string that appears in the REST API URL that identifies the owning service.
String	getViewServiceWiki()	Return the URL for the wiki page describing this UI view.
static ViewServiceDescription	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ViewServiceDescription[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GLOSSARY_AUTHOR

public static final ViewServiceDescription GLOSSARY_AUTHOR

REPOSITORY_EXPLORER

public static final ViewServiceDescription REPOSITORY_EXPLORER

TYPE_EXPLORER

public static final ViewServiceDescription TYPE_EXPLORER

DINO

public static final ViewServiceDescription DINO

SERVER_AUTHOR

public static final ViewServiceDescription SERVER_AUTHOR

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(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:

IllegalArgumentException - if this enum type 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 name for the wiki page