Package org.odpi.openmetadata.frameworks.connectors.controls

Enum Class TemplateTypeEnum

java.lang.Object

java.lang.Enum<TemplateTypeEnum>

org.odpi.openmetadata.frameworks.connectors.controls.TemplateTypeEnum

All Implemented Interfaces:

Serializable, Comparable<TemplateTypeEnum>, Constable

public enum TemplateTypeEnum
extends Enum<TemplateTypeEnum>

TemplateTypeEnum characterises the type of templates supported by an integration connector. It should be copied by developers of an integration connector to help populate the supportedTemplates property of its provider.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXAMPLE

Method Summary

Modifier and Type	Method	Description
String	getDefaultTemplateGUID()	Return the unique identifier of the default template to use with this connector - this is optional.
Map<String,String>	getOtherPropertyValues()	Return a map of property name to property value that the catalog template should have to be valid for this integration connector.
boolean	getRequired()	Return whether this catalog template is required for this service to work successful.
String	getTemplateDescription()	Return the description of the template, such as its content.
String	getTemplateName()	Return the name of the template.
TemplateType	getTemplateType()	Return the catalog template type for a specific catalog template enum.
static List<TemplateType>	getTemplateTypes()	Return all the template types defined by this enum.
String	getTypeName()	Return the open metadata type name.
String	toString()	JSON-style toString
static TemplateTypeEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TemplateTypeEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXAMPLE

public static final TemplateTypeEnum EXAMPLE

Method Details

values

public static TemplateTypeEnum[] 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 TemplateTypeEnum 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

getTemplateName

public String getTemplateName()

Return the name of the template.

Returns:

name

getTemplateDescription

public String getTemplateDescription()

Return the description of the template, such as its content.

Returns:

description

getTypeName

public String getTypeName()

Return the open metadata type name.

Returns:

open metadata type name

getRequired

public boolean getRequired()

Return whether this catalog template is required for this service to work successful.

Returns:

boolean flag

getDefaultTemplateGUID

public String getDefaultTemplateGUID()

Return the unique identifier of the default template to use with this connector - this is optional.

Returns:

string

getOtherPropertyValues

public Map<String,String> getOtherPropertyValues()

Return a map of property name to property value that the catalog template should have to be valid for this integration connector.

Returns:

map of string to string

getTemplateTypes

public static List<TemplateType> getTemplateTypes()

Return all the template types defined by this enum.

Returns:

list of catalog template type

getTemplateType

public TemplateType getTemplateType()

Return the catalog template type for a specific catalog template enum.

Returns:

catalog template type

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<TemplateTypeEnum>

Returns:

return string containing the property names and values