Package com.oracle.bmc.datacatalog.model

Class TermSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datacatalog.model.TermSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class TermSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Summary of a term.

A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level.
Note: Objects should always be created or deserialized using the TermSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the TermSummary.Builder, which maintain a set of all explicitly set fields called TermSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
TermSummary(String key, String displayName, String description, String glossaryKey, String uri, String parentTermKey, Boolean isAllowedToHaveChildTerms, String path, Date timeCreated, TermWorkflowStatus workflowStatus, Integer associatedObjectCount, LifecycleState lifecycleState)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static TermSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getAssociatedObjectCount()	The number of objects tagged with this term.
String	getDescription()	Detailed description of the term.
String	getDisplayName()	A user-friendly display name.
String	getGlossaryKey()	Unique id of the parent glossary.
Boolean	getIsAllowedToHaveChildTerms()	Indicates whether a term may contain child terms.
String	getKey()	Unique term key that is immutable.
LifecycleState	getLifecycleState()	State of the term.
String	getParentTermKey()	This terms parent term key.
String	getPath()	Absolute path of the term.
Date	getTimeCreated()	The date and time the term was created, in the format defined by RFC3339.
String	getUri()	URI to the term instance in the API.
TermWorkflowStatus	getWorkflowStatus()	Status of the approval process workflow for this business term in the glossary.
int	hashCode()
TermSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

TermSummary

@Deprecated
@ConstructorProperties({"key","displayName","description","glossaryKey","uri","parentTermKey","isAllowedToHaveChildTerms","path","timeCreated","workflowStatus","associatedObjectCount","lifecycleState"})
public TermSummary(String key,
                   String displayName,
                   String description,
                   String glossaryKey,
                   String uri,
                   String parentTermKey,
                   Boolean isAllowedToHaveChildTerms,
                   String path,
                   Date timeCreated,
                   TermWorkflowStatus workflowStatus,
                   Integer associatedObjectCount,
                   LifecycleState lifecycleState)

Deprecated.

Method Detail

builder

public static TermSummary.Builder builder()

Create a new builder.

toBuilder

public TermSummary.Builder toBuilder()

getKey

public String getKey()

Unique term key that is immutable.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

Detailed description of the term.

Returns:

the value

getGlossaryKey

public String getGlossaryKey()

Unique id of the parent glossary.

Returns:

the value

getUri

public String getUri()

URI to the term instance in the API.

Returns:

the value

getParentTermKey

public String getParentTermKey()

This terms parent term key.

Will be null if the term has no parent term.

Returns:

the value

getIsAllowedToHaveChildTerms

public Boolean getIsAllowedToHaveChildTerms()

Indicates whether a term may contain child terms.

Returns:

the value

getPath

public String getPath()

Absolute path of the term.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the term was created, in the format defined by RFC3339.

Example: 2019-03-25T21:10:29.600Z

Returns:

the value

getWorkflowStatus

public TermWorkflowStatus getWorkflowStatus()

Status of the approval process workflow for this business term in the glossary.

Returns:

the value

getAssociatedObjectCount

public Integer getAssociatedObjectCount()

The number of objects tagged with this term.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

State of the term.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel