Topic (Subject Area OMAS Server-side 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.generated.entities.Topic.Topic

All Implemented Interfaces:

Serializable
```
public class Topic
extends Object
implements Serializable
```
Topic entity in the Subject Area OMAS. A location for storing and distributing related events.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<String>`	`ATTRIBUTE_NAMES_SET`
`static String[]`	`ATTRIBUTE_NAMES_SET_VALUES`
`static Set<String>`	`ENUM_NAMES_SET`
`static String[]`	`ENUM_NAMES_SET_VALUES`
`static Set<String>`	`MAP_NAMES_SET`
`static String[]`	`MAP_NAMES_SET_VALUES`
`static Set<String>`	`PROPERTY_NAMES_SET`
`static String[]`	`PROPERTY_NAMES_SET_VALUES`

Constructor Summary

Constructors
Constructor and Description

Topic()

Constructors
Constructor and Description
`Topic()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAdditionalProperties()` {@literal Additional properties for the element.
`List<Classification>`	`getClassifications()` Classifications
`String`	`getDescription()` {@literal Description of the asset.
`Date`	`getEffectiveFromTime()` Return the date/time that this Topic should start to be used (null means it can be used from creationTime).
`Date`	`getEffectiveToTime()` Return the date/time that this Topic should no longer be used.
`Map<String,Object>`	`getExtraAttributes()` Get the extra attributes - ones that are in addition to the standard types.
`Map<String,Classification>`	`getExtraClassifications()` Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
`String`	`getLatestChange()` {@literal Description of the last change to the asset's metadata.
`String`	`getName()` {@literal Display name for the asset.
`String`	`getOwner()` {@literal Identifier of the person or process that owns the asset.
`AssetOwnerType`	`getOwnerType()` {@literal Type of identifier used for owner property.
`String`	`getQualifiedName()` {@literal Unique identifier for the entity.
`SystemAttributes`	`getSystemAttributes()` Get the system attributes
`String`	`getTopicType()` {@literal Type of topic.
`List<String>`	`getZoneMembership()` {@literal The list of zones that this asset belongs to.
`int`	`hashCode()`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setClassifications(List<Classification> classifications)`
`void`	`setDescription(String description)`
`void`	`setEffectiveFromTime(Date effectiveFromTime)`
`void`	`setEffectiveToTime(Date effectiveToTime)`
`void`	`setExtraAttributes(Map<String,Object> extraAttributes)`
`void`	`setExtraClassifications(Map<String,Classification> extraClassifications)`
`void`	`setLatestChange(String latestChange)`
`void`	`setName(String name)`
`void`	`setOwner(String owner)`
`void`	`setOwnerType(AssetOwnerType ownerType)`
`void`	`setQualifiedName(String qualifiedName)`
`void`	`setSystemAttributes(SystemAttributes systemAttributes)`
`void`	`setTopicType(String topicType)`
`void`	`setZoneMembership(List<String> zoneMembership)`
`String`	`toString()`
`StringBuilder`	`toString(StringBuilder sb)`

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

Field Detail

PROPERTY_NAMES_SET_VALUES

public static final String[] PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

public static final String[] ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

public static final String[] ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

public static final String[] MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

public static final Set<String> PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

public static final Set<String> ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

public static final Set<String> ENUM_NAMES_SET

MAP_NAMES_SET

public static final Set<String> MAP_NAMES_SET

Constructor Detail
- Topic
```
public Topic()
```

Method Detail
- getSystemAttributes
```
public SystemAttributes getSystemAttributes()
```
  Get the system attributes
  
  Returns:
  
  SystemAttributes if populated, null otherwise.
- setSystemAttributes
```
public void setSystemAttributes(SystemAttributes systemAttributes)
```
- getTopicType
```
public String getTopicType()
```
  Type of topic.
  
  Returns:
  
  String
- setTopicType
```
public void setTopicType(String topicType)
```
- getName
```
public String getName()
```
  Display name for the asset.
  
  Returns:
  
  String
- setName
```
public void setName(String name)
```
- getDescription
```
public String getDescription()
```
  Description of the asset.
  
  Returns:
  
  String
- setDescription
```
public void setDescription(String description)
```
- getOwner
```
public String getOwner()
```
  Identifier of the person or process that owns the asset.
  
  Returns:
  
  String
- setOwner
```
public void setOwner(String owner)
```
- getOwnerType
```
public AssetOwnerType getOwnerType()
```
  Type of identifier used for owner property.
  
  Returns:
  
  AssetOwnerType
- setOwnerType
```
public void setOwnerType(AssetOwnerType ownerType)
```
- getZoneMembership
```
public List<String> getZoneMembership()
```
  The list of zones that this asset belongs to.
  
  Returns:
  
  {@code List<String> }
- setZoneMembership
```
public void setZoneMembership(List<String> zoneMembership)
```
- getLatestChange
```
public String getLatestChange()
```
  Description of the last change to the asset's metadata.
  
  Returns:
  
  String
- setLatestChange
```
public void setLatestChange(String latestChange)
```
- getQualifiedName
```
public String getQualifiedName()
```
  Unique identifier for the entity.
  
  Returns:
  
  String
- setQualifiedName
```
public void setQualifiedName(String qualifiedName)
```
- getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
  Additional properties for the element.
  
  Returns:
  
  {@code Map<String,String> }
- setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
- getEffectiveFromTime
```
public Date getEffectiveFromTime()
```
  Return the date/time that this Topic should start to be used (null means it can be used from creationTime).
  
  Returns:
  
  Date the Topic becomes effective.
- setEffectiveFromTime
```
public void setEffectiveFromTime(Date effectiveFromTime)
```
- getEffectiveToTime
```
public Date getEffectiveToTime()
```
  Return the date/time that this Topic should no longer be used.
  
  Returns:
  
  Date the Topic stops being effective.
- setEffectiveToTime
```
public void setEffectiveToTime(Date effectiveToTime)
```
- setExtraAttributes
```
public void setExtraAttributes(Map<String,Object> extraAttributes)
```
- setClassifications
```
public void setClassifications(List<Classification> classifications)
```
- getExtraAttributes
```
public Map<String,Object> getExtraAttributes()
```
  Get the extra attributes - ones that are in addition to the standard types.
  
  Returns:
  
  map of attributes, null if there are none
- getClassifications
```
public List<Classification> getClassifications()
```
  Classifications
  
  Returns:
  
  List of Classifications, null if there are none
- getExtraClassifications
```
public Map<String,Classification> getExtraClassifications()
```
  Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
  
  Returns:
  
  Map of classifications with the classification Name as the map key
- setExtraClassifications
```
public void setExtraClassifications(Map<String,Classification> extraClassifications)
```
- toString
```
public StringBuilder toString(StringBuilder sb)
```
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class Topic

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

MAP_NAMES_SET

Constructor Detail

Topic

Method Detail

getSystemAttributes

setSystemAttributes

getTopicType

setTopicType

getName

setName

getDescription

setDescription

getOwner

setOwner

getOwnerType

setOwnerType

getZoneMembership

setZoneMembership

getLatestChange

setLatestChange

getQualifiedName

setQualifiedName

getAdditionalProperties

setAdditionalProperties

getEffectiveFromTime

setEffectiveFromTime

getEffectiveToTime

setEffectiveToTime

setExtraAttributes

setClassifications

getExtraAttributes

getClassifications

getExtraClassifications

setExtraClassifications

toString

equals

hashCode

toString