eu.ehri.project.models

Interface Annotation

All Superinterfaces:

Accessible, Entity, PermissionGrantTarget, Promotable, com.tinkerpop.frames.VertexFrame

public interface Annotation
extends Promotable

A frame class representing an annotation.

Nested Class Summary

Nested classes/interfaces inherited from interface eu.ehri.project.models.base.Promotable

Promotable.Impl

Field Summary

Fields inherited from interface eu.ehri.project.models.base.Promotable

PROMOTION_SCORE

Method Summary

Modifier and Type	Method and Description
Iterable<Annotation>	getAnnotations() Fetch annotations that have been made on this annotation.
UserProfile	getAnnotator() Fetch the annotator of this annotation.
String	getBody() Get the body of this annotation.
Iterable<Annotatable>	getTargetParts() Fetch all targets of this annotation, including sub-parts of an item.
Iterable<Annotatable>	getTargets() Fetch the targets of this annotation.
void	setAnnotator(UserProfile annotator) Set the annotator of this annotation.

Methods inherited from interface eu.ehri.project.models.base.Promotable

addDemotion, addPromotion, getDemoters, getPromoters, getPromotionScore, isPromotable, isPromoted, isPromotedBy, removeDemotion, removePromotion

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Method Detail

getAnnotations

Iterable<Annotation> getAnnotations()

Fetch annotations that have been made on this annotation.

Returns:

an iterable of annotation frames

getAnnotator

UserProfile getAnnotator()

Fetch the annotator of this annotation.

Returns:

an annotator frame

setAnnotator

void setAnnotator(UserProfile annotator)

Set the annotator of this annotation.

Parameters:

annotator - an annotator frame

getTargetParts

Iterable<Annotatable> getTargetParts()

Fetch all targets of this annotation, including sub-parts of an item.

Returns:

an iterable of annotatable items

getTargets

Iterable<Annotatable> getTargets()

Fetch the targets of this annotation.

Returns:

an iterable of annotatable items

getBody

String getBody()

Get the body of this annotation.

Returns:

the body text