ElementType (Open Connector Framework (OCF) 1.8 API)

java.lang.Object
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
- - org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementType

All Implemented Interfaces:

Serializable
```
public class ElementType
extends PropertyBase
```
The ElementType bean provides details of the type information associated with a metadata element.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`elementHomeMetadataCollectionId`
`protected String`	`elementHomeMetadataCollectionName`
`protected String`	`elementLicense`
`protected ElementOrigin`	`elementOrigin`
`protected String`	`elementSourceServer`
`protected List<String>`	`elementSuperTypeNames`
`protected String`	`elementTypeDescription`
`protected String`	`elementTypeId`
`protected String`	`elementTypeName`
`protected long`	`elementTypeVersion`

Constructor Summary

Constructors
Constructor and Description

ElementType()
Default constructor

ElementType(ElementType templateType)
Copy/clone constructor

Constructors
Constructor and Description
`ElementType()` Default constructor
`ElementType(ElementType templateType)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Compare the values of the supplied object with those stored in the current object.
`String`	`getElementHomeMetadataCollectionId()` Returns the OMRS identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
`String`	`getElementHomeMetadataCollectionName()` Return the name of the metadata collection that this asset belongs to.
`String`	`getElementLicense()` Return the license associated with this metadata element (null means none).
`ElementOrigin`	`getElementOrigin()` Return the origin of the metadata element.
`String`	`getElementSourceServer()` Return the URL of the server where the element was retrieved from.
`List<String>`	`getElementSuperTypeNames()` Return the list of type names for this type's supertypes.
`String`	`getElementTypeDescription()` Return the description for this element's type.
`String`	`getElementTypeId()` Return unique identifier for the element's type.
`String`	`getElementTypeName()` Return name of element's type.
`long`	`getElementTypeVersion()` Return the version number for this element's type.
`int`	`hashCode()` Create a hash code for this element type.
`void`	`setElementHomeMetadataCollectionId(String elementHomeMetadataCollectionId)` Set up the unique identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
`void`	`setElementHomeMetadataCollectionName(String elementHomeMetadataCollectionName)` Set up the name of the metadata collection that this asset belongs to.
`void`	`setElementLicense(String elementLicense)` Set up the license associated with this metadata element (null means none)
`void`	`setElementOrigin(ElementOrigin elementOrigin)` Set up the details of this element's origin.
`void`	`setElementSourceServer(String elementSourceServer)` Set up the URL of the server where the element was retrieved from.
`void`	`setElementSuperTypeNames(List<String> elementSuperTypeNames)` Set up the list of type names for this type's supertypes.
`void`	`setElementTypeDescription(String elementTypeDescription)` Set up a short description of this element's type.
`void`	`setElementTypeId(String elementTypeId)` Set up the unique identifier for the element's type.
`void`	`setElementTypeName(String elementTypeName)` Set up the name of this element's type
`void`	`setElementTypeVersion(long elementTypeVersion)` Set up the version number for this element's type
`String`	`toString()` Standard toString method.

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

- Field Detail
  - elementTypeId
```
protected String elementTypeId
```
  - elementTypeName
```
protected String elementTypeName
```
  - elementSuperTypeNames
```
protected List<String> elementSuperTypeNames
```
  - elementTypeVersion
```
protected long elementTypeVersion
```
  - elementTypeDescription
```
protected String elementTypeDescription
```
  - elementSourceServer
```
protected String elementSourceServer
```
  - elementOrigin
```
protected ElementOrigin elementOrigin
```
  - elementHomeMetadataCollectionId
```
protected String elementHomeMetadataCollectionId
```
  - elementHomeMetadataCollectionName
```
protected String elementHomeMetadataCollectionName
```
  - elementLicense
```
protected String elementLicense
```
- Constructor Detail
  - ElementType
```
public ElementType()
```
    Default constructor
  - ElementType
```
public ElementType(ElementType templateType)
```
    Copy/clone constructor
    
    Parameters:
    
    templateType - type to clone
- Method Detail
  - setElementTypeId
```
public void setElementTypeId(String elementTypeId)
```
    Set up the unique identifier for the element's type.
    
    Parameters:
    
    elementTypeId - String identifier
  - getElementTypeId
```
public String getElementTypeId()
```
    Return unique identifier for the element's type.
    
    Returns:
    
    element type id
  - setElementTypeName
```
public void setElementTypeName(String elementTypeName)
```
    Set up the name of this element's type
    
    Parameters:
    
    elementTypeName - String name
  - getElementTypeName
```
public String getElementTypeName()
```
    Return name of element's type.
    
    Returns:
    
    elementTypeName
  - setElementSuperTypeNames
```
public void setElementSuperTypeNames(List<String> elementSuperTypeNames)
```
    Set up the list of type names for this type's supertypes.
    
    Parameters:
    
    elementSuperTypeNames - list of type names
  - getElementSuperTypeNames
```
public List<String> getElementSuperTypeNames()
```
    Return the list of type names for this type's supertypes.
    
    Returns:
    
    list of type names
  - setElementTypeVersion
```
public void setElementTypeVersion(long elementTypeVersion)
```
    Set up the version number for this element's type
    
    Parameters:
    
    elementTypeVersion - version number for the element type.
  - getElementTypeVersion
```
public long getElementTypeVersion()
```
    Return the version number for this element's type.
    
    Returns:
    
    elementTypeVersion version number for the element type.
  - setElementTypeDescription
```
public void setElementTypeDescription(String elementTypeDescription)
```
    Set up a short description of this element's type.
    
    Parameters:
    
    elementTypeDescription - set up the description for this element's type
  - getElementTypeDescription
```
public String getElementTypeDescription()
```
    Return the description for this element's type.
    
    Returns:
    
    elementTypeDescription String description for the element type
  - setElementSourceServer
```
public void setElementSourceServer(String elementSourceServer)
```
    Set up the URL of the server where the element was retrieved from. Typically this is a server where the OMAS interfaces are activated. If no URL is known for the server then null is returned.
    
    Parameters:
    
    elementSourceServer - URL of the server
  - getElementSourceServer
```
public String getElementSourceServer()
```
    Return the URL of the server where the element was retrieved from. Typically this is a server where the OMAS interfaces are activated. If no URL is known for the server then null is returned.
    
    Returns:
    
    elementSourceServerURL the url of the server where the element came from
  - setElementOrigin
```
public void setElementOrigin(ElementOrigin elementOrigin)
```
    Set up the details of this element's origin.
    
    Parameters:
    
    elementOrigin - see ElementOrigin enum
  - getElementOrigin
```
public ElementOrigin getElementOrigin()
```
    Return the origin of the metadata element.
    
    Returns:
    
    ElementOrigin enum
  - getElementHomeMetadataCollectionId
```
public String getElementHomeMetadataCollectionId()
```
    Returns the OMRS identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
    
    Returns:
    
    String metadata collection id
  - setElementHomeMetadataCollectionId
```
public void setElementHomeMetadataCollectionId(String elementHomeMetadataCollectionId)
```
    Set up the unique identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
    
    Parameters:
    
    elementHomeMetadataCollectionId - String unique identifier for the home metadata repository
  - getElementHomeMetadataCollectionName
```
public String getElementHomeMetadataCollectionName()
```
    Return the name of the metadata collection that this asset belongs to.
    
    Returns:
    
    name string
  - setElementHomeMetadataCollectionName
```
public void setElementHomeMetadataCollectionName(String elementHomeMetadataCollectionName)
```
    Set up the name of the metadata collection that this asset belongs to.
    
    Parameters:
    
    elementHomeMetadataCollectionName - name string
  - getElementLicense
```
public String getElementLicense()
```
    Return the license associated with this metadata element (null means none).
    
    Returns:
    
    string license name
  - setElementLicense
```
public void setElementLicense(String elementLicense)
```
    Set up the license associated with this metadata element (null means none)
    
    Parameters:
    
    elementLicense - string license name
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Create a hash code for this element type.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class ElementType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elementTypeId

elementTypeName

elementSuperTypeNames

elementTypeVersion

elementTypeDescription

elementSourceServer

elementOrigin

elementHomeMetadataCollectionId

elementHomeMetadataCollectionName

elementLicense

Constructor Detail

ElementType

ElementType

Method Detail

setElementTypeId

getElementTypeId

setElementTypeName

getElementTypeName

setElementSuperTypeNames

getElementSuperTypeNames

setElementTypeVersion

getElementTypeVersion

setElementTypeDescription

getElementTypeDescription

setElementSourceServer

getElementSourceServer

setElementOrigin

getElementOrigin

getElementHomeMetadataCollectionId

setElementHomeMetadataCollectionId

getElementHomeMetadataCollectionName

setElementHomeMetadataCollectionName

getElementLicense

setElementLicense

toString

equals

hashCode