org.odpi.openmetadata.userinterface.adminservices.configuration.registration

Enum CommonUIServicesDescription

java.lang.Object

java.lang.Enum<CommonUIServicesDescription>

org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription

All Implemented Interfaces:

Serializable, Comparable<CommonUIServicesDescription>

public enum CommonUIServicesDescription
extends Enum<CommonUIServicesDescription>
implements Serializable

ViewServiceDescription provides a list of registered OMAS services.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN_OPERATIONAL_SERVICES
OPEN_METADATA_SECURITY

Method Summary

Modifier and Type	Method and Description
static List<CommonUIServicesDescription>	getGovernanceServersDescriptionList() Return a list containing each of the view service descriptions defined in this enum class.
int	getServiceCode() Return the code for this enum instance
String	getServiceDescription() Return the default description for the type for this enum instance.
String	getServiceName() Return the default name for this enum instance.
String	getServiceURLMarker() Return the string that appears in the REST API URL that identifies the owning service.
String	getServiceWiki() Return the URL for the wiki page describing this view service.
static CommonUIServicesDescription	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommonUIServicesDescription[]	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

ADMIN_OPERATIONAL_SERVICES

public static final CommonUIServicesDescription ADMIN_OPERATIONAL_SERVICES

OPEN_METADATA_SECURITY

public static final CommonUIServicesDescription OPEN_METADATA_SECURITY

Method Detail

values

public static CommonUIServicesDescription[] 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 (CommonUIServicesDescription c : CommonUIServicesDescription.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommonUIServicesDescription 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

getGovernanceServersDescriptionList

public static List<CommonUIServicesDescription> getGovernanceServersDescriptionList()

Return a list containing each of the view 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

getServiceName

public String getServiceName()

Return the default name for this enum instance.

Returns:

String default name

getServiceURLMarker

public 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 String getServiceDescription()

Return the default description for the type for this enum instance.

Returns:

String default description

getServiceWiki

public String getServiceWiki()

Return the URL for the wiki page describing this view service.

Returns:

String URL name for the wiki page