ReferenceableRequestBody (OCF Metadata Management API 2.9 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.OCFOMASAPIRequestBody
- - org.odpi.openmetadata.commonservices.ocf.metadatamanagement.rest.ReferenceableRequestBody

All Implemented Interfaces:

Serializable
```
public class ReferenceableRequestBody
extends OCFOMASAPIRequestBody
```
ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`additionalProperties`
`protected List<ElementClassification>`	`classifications`
`protected Map<String,Object>`	`extendedProperties`
`protected List<Meaning>`	`meanings`
`protected String`	`qualifiedName`
`protected String`	`typeName`

Constructor Summary

Constructors
Constructor and Description

ReferenceableRequestBody()
Default constructor

ReferenceableRequestBody(ReferenceableRequestBody template)
Copy/clone constructor

Constructors
Constructor and Description
`ReferenceableRequestBody()` Default constructor
`ReferenceableRequestBody(ReferenceableRequestBody template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Equals method that returns true if containing properties are the same.
`Map<String,String>`	`getAdditionalProperties()` Return a copy of the additional properties.
`List<ElementClassification>`	`getClassifications()` Return the classifications associated with this referenceable.
`Map<String,Object>`	`getExtendedProperties()` Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
`List<Meaning>`	`getMeanings()` Return the assigned meanings for this metadata entity.
`String`	`getQualifiedName()` Returns the stored qualified name property for the metadata entity.
`String`	`getTypeName()` Return the open metadata type name of this object - this is used to create a subtype of the referenceable.
`int`	`hashCode()` Return hash code for this object
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)` Set up additional properties.
`void`	`setClassifications(List<ElementClassification> classifications)` Set up the list of classifications associated with this referenceable.
`void`	`setExtendedProperties(Map<String,Object> extendedProperties)` Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
`void`	`setMeanings(List<Meaning> meanings)` Set up the assigned meanings for this metadata entity.
`void`	`setQualifiedName(String qualifiedName)` Set up the fully qualified name.
`void`	`setTypeName(String typeName)` Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.
`String`	`toString()` JSON-style toString.

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

- Field Detail
  - typeName
```
protected String typeName
```
  - classifications
```
protected List<ElementClassification> classifications
```
  - qualifiedName
```
protected String qualifiedName
```
  - meanings
```
protected List<Meaning> meanings
```
  - additionalProperties
```
protected Map<String,String> additionalProperties
```
  - extendedProperties
```
protected Map<String,Object> extendedProperties
```
- Constructor Detail
  - ReferenceableRequestBody
```
public ReferenceableRequestBody()
```
    Default constructor
  - ReferenceableRequestBody
```
public ReferenceableRequestBody(ReferenceableRequestBody template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getTypeName
```
public String getTypeName()
```
    Return the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
    
    Returns:
    
    string type name
  - setTypeName
```
public void setTypeName(String typeName)
```
    Set up the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
    
    Parameters:
    
    typeName - string type name
  - getClassifications
```
public List<ElementClassification> getClassifications()
```
    Return the classifications associated with this referenceable.
    
    Returns:
    
    list of classifications with their properties
  - setClassifications
```
public void setClassifications(List<ElementClassification> classifications)
```
    Set up the list of classifications associated with this referenceable.
    
    Parameters:
    
    classifications - list of classifications with their properties
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.
    
    Returns:
    
    qualifiedName
  - setQualifiedName
```
public void setQualifiedName(String qualifiedName)
```
    Set up the fully qualified name.
    
    Parameters:
    
    qualifiedName - String name
  - getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
    Return a copy of the additional properties. Null means no additional properties are available.
    
    Returns:
    
    AdditionalProperties
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
    Set up additional properties.
    
    Parameters:
    
    additionalProperties - Additional properties object
  - getMeanings
```
public List<Meaning> getMeanings()
```
    Return the assigned meanings for this metadata entity.
    
    Returns:
    
    list of meanings
  - setMeanings
```
public void setMeanings(List<Meaning> meanings)
```
    Set up the assigned meanings for this metadata entity.
    
    Parameters:
    
    meanings - list of meanings
  - getExtendedProperties
```
public Map<String,Object> getExtendedProperties()
```
    Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
    
    Returns:
    
    map of properties
  - setExtendedProperties
```
public void setExtendedProperties(Map<String,Object> extendedProperties)
```
    Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
    
    Parameters:
    
    extendedProperties - map of properties
  - toString
```
public String toString()
```
    JSON-style toString.
    
    Overrides:
    
    toString in class OCFOMASAPIRequestBody
    
    Returns:
    
    list of properties and their values.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Equals method that returns true if containing properties are the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - object to compare
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Return hash code for this object
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class ReferenceableRequestBody

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

typeName

classifications

qualifiedName

meanings

additionalProperties

extendedProperties

Constructor Detail

ReferenceableRequestBody

ReferenceableRequestBody

Method Detail

getTypeName

setTypeName

getClassifications

setClassifications

getQualifiedName

setQualifiedName

getAdditionalProperties

setAdditionalProperties

getMeanings

setMeanings

getExtendedProperties

setExtendedProperties

toString

equals

hashCode