TypeDef (Repository Services General APIs 2.8 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader
- - org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink
  - - org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary
    - - org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClassificationDef, EntityDef, RelationshipDef
```
public abstract class TypeDef
extends TypeDefSummary
```
The TypeDef is the base class for objects that store the properties of an open metadata type definition (call ed a TypeDef).
The different categories of Typedefs are listed in TypeDefCategory.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`createdBy`
`protected Date`	`createTime`
`protected String`	`description`
`protected String`	`descriptionGUID`
`protected List<ExternalStandardMapping>`	`externalStandardMappings`
`protected InstanceStatus`	`initialStatus`
`protected Map<String,String>`	`options`
`protected String`	`origin`
`protected List<TypeDefAttribute>`	`propertiesDefinition`
`protected TypeDefLink`	`superType`
`protected String`	`updatedBy`
`protected Date`	`updateTime`
`protected List<InstanceStatus>`	`validInstanceStatusList`

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary
category, version, versionName

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink
guid, name, replacedByTypeGUID, replacedByTypeName, status

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader
CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TypeDef()` Default constructor
`protected`	`TypeDef(TypeDef template)` Copy/clone constructor copies the values from the supplied template.
`protected`	`TypeDef(TypeDefCategory category)` Minimal constructor is passed the category of the typedef being constructed.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract TypeDef`	`cloneFromSubclass()` Delegate the process of cloning to the subclass.
`boolean`	`equals(Object objectToCompare)` Validate that an object is equal depending on their stored values.
`String`	`getCreatedBy()` Return the user name of the person that created this TypeDef.
`Date`	`getCreateTime()` Return the date/time that this TypeDef was created.
`String`	`getDescription()` Return the description of this TypeDef.
`String`	`getDescriptionGUID()` Return the unique identifier (guid) of the glossary term that describes this TypeDef.
`List<ExternalStandardMapping>`	`getExternalStandardMappings()` Return the list of mappings to external standards.
`InstanceStatus`	`getInitialStatus()` Return the initial status setting for an instance of this type.
`Map<String,String>`	`getOptions()` Return the options for this TypeDef.
`String`	`getOrigin()` Return the unique identifier for metadata collection Id where this TypeDef came from.
`List<TypeDefAttribute>`	`getPropertiesDefinition()` Return the list of typeDefAttributes that are either new or changing.
`TypeDefLink`	`getSuperType()` Return the super type for the TypeDef (or null if top-level)
`String`	`getUpdatedBy()` Return the user name of the person that last updated this TypeDef.
`Date`	`getUpdateTime()` Return the date/time that this TypeDef was last updated.
`List<InstanceStatus>`	`getValidInstanceStatusList()` Return the list of valid statuses for an instance of this TypeDef.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setCreatedBy(String createdBy)` Set up the user name of the person that created this TypeDef.
`void`	`setCreateTime(Date createTime)` Set up the date/time that this TypeDef was created.
`void`	`setDescription(String description)` Set up the description of this TypeDef.
`void`	`setDescriptionGUID(String descriptionGUID)` Set up the unique identifier (guid) of the glossary term that describes this TypeDef.
`void`	`setExternalStandardMappings(List<ExternalStandardMapping> externalStandardMappings)` Set up the list of mappings to external standards.
`void`	`setInitialStatus(InstanceStatus initialStatus)` Set up the initial status setting for an instance of this type.
`void`	`setOptions(Map<String,String> options)` Set up the options for this TypeDef.
`void`	`setOrigin(String origin)` Set up the unique identifier for metadata collection Id where this TypeDef came from.
`void`	`setPropertiesDefinition(List<TypeDefAttribute> propertiesDefinition)` Set up the list of AttributeDefs that define the valid properties for this type of classification.
`void`	`setSuperType(TypeDefLink superType)` Set up supertype for the TypeDef.
`void`	`setUpdatedBy(String updatedBy)` Set up the user name of the person that last updated this TypeDef.
`void`	`setUpdateTime(Date updateTime)` Set up the date/time that this TypeDef was last updated.
`void`	`setValidInstanceStatusList(List<InstanceStatus> validInstanceStatusList)` Set up the list of valid instance statuses supported by this TypeDef.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary
getCategory, getVersion, getVersionName, setCategory, setVersion, setVersionName

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink
getGUID, getName, getReplacedByTypeGUID, getReplacedByTypeName, getStatus, setGUID, setName, setReplacedByTypeGUID, setReplacedByTypeName, setStatus

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader
getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - superType
```
protected TypeDefLink superType
```
  - description
```
protected String description
```
  - descriptionGUID
```
protected String descriptionGUID
```
  - origin
```
protected String origin
```
  - createdBy
```
protected String createdBy
```
  - updatedBy
```
protected String updatedBy
```
  - createTime
```
protected Date createTime
```
  - updateTime
```
protected Date updateTime
```
  - options
```
protected Map<String,String> options
```
  - externalStandardMappings
```
protected List<ExternalStandardMapping> externalStandardMappings
```
  - validInstanceStatusList
```
protected List<InstanceStatus> validInstanceStatusList
```
  - initialStatus
```
protected InstanceStatus initialStatus
```
  - propertiesDefinition
```
protected List<TypeDefAttribute> propertiesDefinition
```
- Constructor Detail
  - TypeDef
```
protected TypeDef()
```
    Default constructor
  - TypeDef
```
protected TypeDef(TypeDefCategory category)
```
    Minimal constructor is passed the category of the typedef being constructed. The rest of the properties are null.
    
    Parameters:
    
    category - TypeDefCategory enum
  - TypeDef
```
protected TypeDef(TypeDef template)
```
    Copy/clone constructor copies the values from the supplied template.
    
    Parameters:
    
    template - TypeDef
- Method Detail
  - cloneFromSubclass
```
public abstract TypeDef cloneFromSubclass()
```
    Delegate the process of cloning to the subclass.
    
    Returns:
    
    subclass of TypeDef
  - getSuperType
```
public TypeDefLink getSuperType()
```
    Return the super type for the TypeDef (or null if top-level)
    
    Returns:
    
    TypeDefLink for the super type
  - setSuperType
```
public void setSuperType(TypeDefLink superType)
```
    Set up supertype for the TypeDef. Only single inheritance is supported. Use null if this type is top-level.
    
    Parameters:
    
    superType - TypeDefLink for the super type
  - getDescription
```
public String getDescription()
```
    Return the description of this TypeDef.
    
    Returns:
    
    String description
  - setDescription
```
public void setDescription(String description)
```
    Set up the description of this TypeDef.
    
    Parameters:
    
    description - String
  - getDescriptionGUID
```
public String getDescriptionGUID()
```
    Return the unique identifier (guid) of the glossary term that describes this TypeDef.
    
    Returns:
    
    String guid
  - setDescriptionGUID
```
public void setDescriptionGUID(String descriptionGUID)
```
    Set up the unique identifier (guid) of the glossary term that describes this TypeDef.
    
    Parameters:
    
    descriptionGUID - String guid
  - getOrigin
```
public String getOrigin()
```
    Return the unique identifier for metadata collection Id where this TypeDef came from.
    
    Returns:
    
    String guid
  - setOrigin
```
public void setOrigin(String origin)
```
    Set up the unique identifier for metadata collection Id where this TypeDef came from.
    
    Parameters:
    
    origin - String guid
  - getCreatedBy
```
public String getCreatedBy()
```
    Return the user name of the person that created this TypeDef.
    
    Returns:
    
    String name
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Set up the user name of the person that created this TypeDef.
    
    Parameters:
    
    createdBy - String name
  - getUpdatedBy
```
public String getUpdatedBy()
```
    Return the user name of the person that last updated this TypeDef.
    
    Returns:
    
    String name
  - setUpdatedBy
```
public void setUpdatedBy(String updatedBy)
```
    Set up the user name of the person that last updated this TypeDef.
    
    Parameters:
    
    updatedBy - String name
  - getCreateTime
```
public Date getCreateTime()
```
    Return the date/time that this TypeDef was created.
    
    Returns:
    
    Date
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    Set up the date/time that this TypeDef was created.
    
    Parameters:
    
    createTime - Date
  - getUpdateTime
```
public Date getUpdateTime()
```
    Return the date/time that this TypeDef was last updated.
    
    Returns:
    
    Date
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    Set up the date/time that this TypeDef was last updated.
    
    Parameters:
    
    updateTime - Date
  - getOptions
```
public Map<String,String> getOptions()
```
    Return the options for this TypeDef. These are private properties used by the processors of this TypeDef and ignored by the OMRS.
    
    Returns:
    
    Map from String to String
  - setOptions
```
public void setOptions(Map<String,String> options)
```
    Set up the options for this TypeDef. These are private properties used by the processors of this TypeDef and ignored by the OMRS.
    
    Parameters:
    
    options - Map from String to String
  - getExternalStandardMappings
```
public List<ExternalStandardMapping> getExternalStandardMappings()
```
    Return the list of mappings to external standards.
    
    Returns:
    
    ExternalStandardMappings list
  - setExternalStandardMappings
```
public void setExternalStandardMappings(List<ExternalStandardMapping> externalStandardMappings)
```
    Set up the list of mappings to external standards.
    
    Parameters:
    
    externalStandardMappings - ExternalStandardMappings list
  - getValidInstanceStatusList
```
public List<InstanceStatus> getValidInstanceStatusList()
```
    Return the list of valid statuses for an instance of this TypeDef.
    
    Returns:
    
    list of valid statuses
  - setValidInstanceStatusList
```
public void setValidInstanceStatusList(List<InstanceStatus> validInstanceStatusList)
```
    Set up the list of valid instance statuses supported by this TypeDef.
    
    Parameters:
    
    validInstanceStatusList - InstanceStatus Array
  - getInitialStatus
```
public InstanceStatus getInitialStatus()
```
    Return the initial status setting for an instance of this type.
    
    Returns:
    
    InstanceStatus enum
  - setInitialStatus
```
public void setInitialStatus(InstanceStatus initialStatus)
```
    Set up the initial status setting for an instance of this type.
    
    Parameters:
    
    initialStatus - InstanceStatus enum
  - getPropertiesDefinition
```
public List<TypeDefAttribute> getPropertiesDefinition()
```
    Return the list of typeDefAttributes that are either new or changing.
    
    Returns:
    
    list of TypeDefAttribute
  - setPropertiesDefinition
```
public void setPropertiesDefinition(List<TypeDefAttribute> propertiesDefinition)
```
    Set up the list of AttributeDefs that define the valid properties for this type of classification.
    
    Parameters:
    
    propertiesDefinition - AttributeDefs list
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class TypeDefSummary
    
    Returns:
    
    JSON style description of variables.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Validate that an object is equal depending on their stored values.
    
    Overrides:
    
    equals in class TypeDefSummary
    
    Parameters:
    
    objectToCompare - object
    
    Returns:
    
    boolean result
  - hashCode
```
public int hashCode()
```
    Return a hash code based on the values of this object.
    
    Overrides:
    
    hashCode in class TypeDefSummary
    
    Returns:
    
    in hash code

Class TypeDef

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

Methods inherited from class java.lang.Object

Field Detail

superType

description

descriptionGUID

origin

createdBy

updatedBy

createTime

updateTime

options

externalStandardMappings

validInstanceStatusList

initialStatus

propertiesDefinition

Constructor Detail

TypeDef

TypeDef

TypeDef

Method Detail

cloneFromSubclass

getSuperType

setSuperType

getDescription

setDescription

getDescriptionGUID

setDescriptionGUID

getOrigin

setOrigin

getCreatedBy

setCreatedBy

getUpdatedBy

setUpdatedBy

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getOptions

setOptions

getExternalStandardMappings

setExternalStandardMappings

getValidInstanceStatusList

setValidInstanceStatusList

getInitialStatus

setInitialStatus

getPropertiesDefinition

setPropertiesDefinition

toString

equals

hashCode