Annotation (Java SDK API Client 0.9.0-SNAPSHOT API)

java.lang.Object
- org.opencode4workspace.bo.Annotation

All Implemented Interfaces:

Serializable
```
public class Annotation
extends Object
implements Serializable
```
Since:

0.5.0 Serializable object corresponding to an annotation for a message

Author:

Christian Guedemann

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Annotation.AnnotationType
Enum for Annotation types

Nested Classes
Modifier and Type	Class and Description
`static class`	`Annotation.AnnotationType` Enum for Annotation types

Constructor Summary

Constructors
Constructor and Description

Annotation()

Constructors
Constructor and Description
`Annotation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Actor`	`getActor()`
`String`	`getColor()`
`Date`	`getCreated()`
`String`	`getCreatedBy()`
`String`	`getId()`
`String`	`getText()`
`String`	`getTitle()`
`Annotation.AnnotationType`	`getType()`
`int`	`getVersion()`
`void`	`setActor(Actor actor)`
`void`	`setColor(String color)`
`void`	`setCreated(Date created)`
`void`	`setCreatedBy(String createdBy)`
`void`	`setId(String id)`
`void`	`setText(String text)`
`void`	`setTitle(String title)`
`void`	`setType(Annotation.AnnotationType type)`
`void`	`setVersion(int version)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Annotation
```
public Annotation()
```
- Method Detail
  - getActor
```
public Actor getActor()
```
    Returns:
    
    Actor referenced in the Annotation
    
    Since:
    
    0.5.0
  - setActor
```
public void setActor(Actor actor)
```
    Parameters:
    
    actor - Actor referenced in the Annotation
    
    Since:
    
    0.5.0
  - getColor
```
public String getColor()
```
    Returns:
    
    String hex colour for the Annotation
    
    Since:
    
    0.5.0
  - setColor
```
public void setColor(String color)
```
    Parameters:
    
    color - String hex colour for the Annotation
    
    Since:
    
    0.5.0
  - getCreated
```
public Date getCreated()
```
    Returns:
    
    Date the Annotation was created
    
    Since:
    
    0.5.0
  - setCreated
```
public void setCreated(Date created)
```
    Parameters:
    
    created - Date the Annotation was created
    
    Since:
    
    0.5.0
  - getCreatedBy
```
public String getCreatedBy()
```
    Returns:
    
    String id of the creator of the Annotation, auto-generated
    
    Since:
    
    0.5.0
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Parameters:
    
    createdBy - String id of the creator of the Annotation, auto-generated
    
    Since:
    
    0.5.0
  - getId
```
public String getId()
```
    Returns:
    
    String id of the Annotation
    
    Since:
    
    0.5.0
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - String id of the Annotation
    
    Since:
    
    0.5.0
  - getText
```
public String getText()
```
    Returns:
    
    String body of text to send inside the Annotation. May include a subset of markdown
    
    Since:
    
    0.5.0
  - setText
```
public void setText(String text)
```
    Parameters:
    
    text - String body of text to send inside the Annotation. May include a subset of markdown
    
    Since:
    
    0.5.0
  - getTitle
```
public String getTitle()
```
    Returns:
    
    String title of the Annotation. May include a subset of markdown
    
    Since:
    
    0.5.0
  - setTitle
```
public void setTitle(String title)
```
    Parameters:
    
    title - String title of the Annotation. May include a subset of markdown
    
    Since:
    
    0.5.0
  - getType
```
public Annotation.AnnotationType getType()
```
    Returns:
    
    String type of the Annotation, default is "generic"
    
    Since:
    
    0.5.0
  - setType
```
public void setType(Annotation.AnnotationType type)
```
    Parameters:
    
    type - String type of the Annotation, default is "generic"
    
    Since:
    
    0.5.0
  - getVersion
```
public int getVersion()
```
    Returns:
    
    int version of the Annotation
    
    Since:
    
    0.5.0
  - setVersion
```
public void setVersion(int version)
```
    Parameters:
    
    version - int version of the Annotation
    
    Since:
    
    0.5.0

Class Annotation

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Annotation

Method Detail

getActor

setActor

getColor

setColor

getCreated

setCreated

getCreatedBy

setCreatedBy

getId

setId

getText

setText

getTitle

setTitle

getType

setType

getVersion

setVersion