org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.types

Class TypeHeader

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.types.TypeHeader

Direct Known Subclasses:

TypeDetails

public class TypeHeader
extends ObjectPrinter

Captures the most basic headline type information available from IGC REST API.

Constructor Summary

Constructors

Constructor and Description
TypeHeader()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare)
String	getClassName() Retrieve the class name of this type, as used for xmeta.
String	getGroup() Retrieve optional field indicating the group of types to which this type belongs.
String	getId() Retrieve the ID of this type, as used in the REST API.
String	getName() Retrieve the display name of this type.
String	getPlural() Retrieve the plural form of the display name of this type.
String	getUrl() Retrieve the URL to retrieve detailed information about the type via the REST API.
int	hashCode()
boolean	includedInBusinessLineage() Retrieve whether this type is included in business lineage (true) or not (false).
boolean	includedInDataLineage() Retrieve whether this type is included in data lineage (true) or not (false).
void	setBusinessLineage(boolean businessLineage) Set whether this type is included in business lineage (true) or not (false).
void	setClassName(String className) Set the class name of this type, as used for xmeta.
void	setDataLineage(boolean dataLineage) Set whether this type is included in data lineage (true) or not (false).
void	setGroup(String group) Set optional field indicating the group of types to which this type belongs.
void	setId(String id) Set the ID of this type, as used in the REST API.
void	setName(String name) Set the display name of this type.
void	setPlural(String plural) Set the plural form of the display name of this type.
void	setUrl(String url) Set the URL to retrieve detailed information about the type via the REST API.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeHeader

public TypeHeader()

Method Detail

includedInBusinessLineage

public boolean includedInBusinessLineage()

Retrieve whether this type is included in business lineage (true) or not (false).

Returns:

boolean

setBusinessLineage

public void setBusinessLineage(boolean businessLineage)

Set whether this type is included in business lineage (true) or not (false).

Parameters:

businessLineage - true to enable business lineage, false to disable it

getName

public String getName()

Retrieve the display name of this type.

Returns:

String

setName

public void setName(String name)

Set the display name of this type.

Parameters:

name - the display name

getPlural

public String getPlural()

Retrieve the plural form of the display name of this type.

Returns:

String

setPlural

public void setPlural(String plural)

Set the plural form of the display name of this type.

Parameters:

plural - the plural form of the display name

getId

public String getId()

Retrieve the ID of this type, as used in the REST API.

Returns:

String

setId

public void setId(String id)

Set the ID of this type, as used in the REST API.

Parameters:

id - the ID of this type

getClassName

public String getClassName()

Retrieve the class name of this type, as used for xmeta.

Returns:

String

setClassName

public void setClassName(String className)

Set the class name of this type, as used for xmeta.

Parameters:

className - the class name of this type

getUrl

public String getUrl()

Retrieve the URL to retrieve detailed information about the type via the REST API.

Returns:

String

setUrl

public void setUrl(String url)

Set the URL to retrieve detailed information about the type via the REST API.

Parameters:

url - the URL to retrieve detailed information about the type

includedInDataLineage

public boolean includedInDataLineage()

Retrieve whether this type is included in data lineage (true) or not (false).

Returns:

boolean

setDataLineage

public void setDataLineage(boolean dataLineage)

Set whether this type is included in data lineage (true) or not (false).

Parameters:

dataLineage - true to enable data lineage, false to disable it

getGroup

public String getGroup()

Retrieve optional field indicating the group of types to which this type belongs.

Returns:

String

setGroup

public void setGroup(String group)

Set optional field indicating the group of types to which this type belongs.

Parameters:

group - the group to which this type belongs

equals

public boolean equals(Object objectToCompare)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object