com.atlassian.confluence.api.model.relations

Class FavouriteRelationDescriptor<T extends Relatable>

java.lang.Object

com.atlassian.confluence.api.model.relations.AbstractRelationDescriptor<User,T>

com.atlassian.confluence.api.model.relations.FavouriteRelationDescriptor<T>

All Implemented Interfaces:

RelationDescriptor<User,T>

public final class FavouriteRelationDescriptor<T extends Relatable>
extends AbstractRelationDescriptor<User,T>

The built-in relationship type for favourites. This relationship works between a User and a Space, Page or Blog Post.

Field Summary

Fields

Modifier and Type	Field and Description
static FavouriteRelationDescriptor<Content>	CONTENT_FAVOURITE The relation type for user Content favourites.
static String	NAME The name of the relationship for user favourites.
static FavouriteRelationDescriptor<Space>	SPACE_FAVOURITE The relation type for user Space favourites.

Method Summary

Methods inherited from class com.atlassian.confluence.api.model.relations.AbstractRelationDescriptor

canRelate, getGenericTypeArgs, getRelationName, getSourceClass, getTargetClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

The name of the relationship for user favourites.

See Also:

Constant Field Values

CONTENT_FAVOURITE

public static final FavouriteRelationDescriptor<Content> CONTENT_FAVOURITE

The relation type for user Content favourites.

SPACE_FAVOURITE

public static final FavouriteRelationDescriptor<Space> SPACE_FAVOURITE

The relation type for user Space favourites.