com.atlassian.confluence.api.model.relations

Interface RelationDescriptor<S extends Relatable,T extends Relatable>

All Known Implementing Classes:

AbstractRelationDescriptor, FavouriteRelationDescriptor, LikeRelationDescriptor, NamedRelationDescriptor

@ExperimentalSpi
public interface RelationDescriptor<S extends Relatable,T extends Relatable>

Defines relation name, type and who may have such relations.

Please do implement ths interface directly, if you need to create your own relation please use AbstractRelationDescriptor or NamedRelationDescriptor

Since:

5.9

Method Summary

Modifier and Type	Method and Description
ValidationResult	canRelate(S source, T target) Returns ValidationResult, which indicates if two given entities may for a relation, described by this RelationDescriptor object
String	getRelationName() Get relation name.
Class<S>	getSourceClass() Returns class of source entity of the relation.
Class<T>	getTargetClass() Returns class of target entity of the relation.

Method Detail

getRelationName

String getRelationName()

Get relation name. Relation name should be unique per relation type. For example: "favouriteContentRelation", "watchRelation" etc.

Returns:

relation name.

canRelate

ValidationResult canRelate(S source,
                           T target)

Returns ValidationResult, which indicates if two given entities may for a relation, described by this RelationDescriptor object

Parameters:

source - entity

target - entity

Returns:

validation result

getSourceClass

Class<S> getSourceClass()

Returns class of source entity of the relation. Source entity is always subclass of Relatable

Returns:

type of source entity

getTargetClass

Class<T> getTargetClass()

Returns class of target entity of the relation. Target entity is always subclass of Relatable

Returns:

type of target entity