Uses of Interface
com.atlassian.confluence.api.model.relations.RelationDescriptor
-
Packages that use RelationDescriptor Package Description com.atlassian.confluence.api.impl.service.relation com.atlassian.confluence.api.model.relations com.atlassian.confluence.api.service.relations com.atlassian.confluence.internal.relations com.atlassian.confluence.internal.relations.dao com.atlassian.confluence.internal.relations.dao.hibernate com.atlassian.confluence.internal.relations.query com.atlassian.confluence.rest.client This package contains the code which communicates with Confluence via REST API.com.atlassian.confluence.rest.client.impl -
-
Uses of RelationDescriptor in com.atlassian.confluence.api.impl.service.relation
Classes in com.atlassian.confluence.api.impl.service.relation that implement RelationDescriptor Modifier and Type Class Description class
AuthenticatedUserRelationDescriptor<S extends User,T extends Relatable>
AValidatingRelationDescriptor
which checks that theUser
for which the relation is being created is also the currently authenticated user.class
DefaultValidatingRelationDescriptor<S extends Relatable,T extends Relatable>
Methods in com.atlassian.confluence.api.impl.service.relation with parameters of type RelationDescriptor Modifier and Type Method Description <S extends Relatable,T extends Relatable>
RelationService.RelatableFinder<S>RelationServiceImpl. findSources(T target, RelationDescriptor<S,T> relationDescriptor)
<S extends Relatable,T extends Relatable>
RelationService.RelatableFinder<T>RelationServiceImpl. findTargets(S source, RelationDescriptor<S,T> relationDescriptor)
<S extends Relatable,T extends Relatable>
booleanRelationServiceImpl. isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
<S extends Relatable,T extends Relatable>
voidRelationServiceImpl. removeAllRelationsFromEntityWithType(RelationDescriptor<S,T> relationDescriptor, Relatable relatable)
Constructors in com.atlassian.confluence.api.impl.service.relation with parameters of type RelationDescriptor Constructor Description AuthenticatedUserRelationDescriptor(RelationDescriptor relationDescriptor)
DefaultValidatingRelationDescriptor(RelationDescriptor relationDescriptor)
-
Uses of RelationDescriptor in com.atlassian.confluence.api.model.relations
Subinterfaces of RelationDescriptor in com.atlassian.confluence.api.model.relations Modifier and Type Interface Description interface
ValidatingRelationDescriptor<S extends Relatable,T extends Relatable>
ARelationDescriptor
which provides a method to perform validation on descriptor operations.Classes in com.atlassian.confluence.api.model.relations that implement RelationDescriptor Modifier and Type Class Description class
AbstractRelationDescriptor<S extends Relatable,T extends Relatable>
Relation descriptor, which should be used as a base class for all custom relation descriptors.class
CollaboratorRelationDescriptor
class
CumulativeContributorRelationDescriptor
The descriptor of relations capturing both direct and indirect contributors of a content.class
FavouriteRelationDescriptor<T extends Relatable>
The built-in relationship type for favourites.class
LikeRelationDescriptor<T extends Relatable>
class
NamedRelationDescriptor<S extends Relatable,T extends Relatable>
Simple implementation ofRelationDescriptor
, which allows to create simple named relation descriptors.class
TouchedRelationDescriptor
Represents that a user has modified content, regardless of whether that change has been reverted.Methods in com.atlassian.confluence.api.model.relations that return RelationDescriptor Modifier and Type Method Description RelationDescriptor<S,T>
RelationInstance. getRelationDescriptor()
static <S extends Relatable,T extends Relatable>
RelationDescriptor<S,T>RelationDescriptors. lookupBuiltinOrCreate(Class<S> sourceClass, String name, Class<T> targetClass)
Get one of the built-in RelationDescriptor objects (for example FavouriteRelationDescriptor).Methods in com.atlassian.confluence.api.model.relations with parameters of type RelationDescriptor Modifier and Type Method Description static <S extends Relatable,T extends Relatable>
RelationInstance.RelationInstanceBuilder<S,T>RelationInstance. builder(S source, RelationDescriptor<S,T> relationDescriptor, T target)
static <S extends Relatable,T extends Relatable>
ValidationResultRelationDescriptors. canRelate(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Deprecated.since 5.11. -
Uses of RelationDescriptor in com.atlassian.confluence.api.service.relations
Methods in com.atlassian.confluence.api.service.relations with parameters of type RelationDescriptor Modifier and Type Method Description <S extends Relatable,T extends Relatable>
RelationService.RelatableFinder<S>RelationService. findSources(T target, RelationDescriptor<S,T> relationDescriptor)
Create a finder to find sources of a relation.<S extends Relatable,T extends Relatable>
RelationService.RelatableFinder<T>RelationService. findTargets(S source, RelationDescriptor<S,T> relationDescriptor)
Create a finder to find targets of a relation.<S extends Relatable,T extends Relatable>
booleanRelationService. isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Determine whether a given source and target are related by the given relation<S extends Relatable,T extends Relatable>
voidRelationService. removeAllRelationsFromEntityWithType(RelationDescriptor<S,T> relationDescriptor, Relatable relatable)
Remove all relations of the given type where the given entity participates<S extends Relatable,T extends Relatable>
ValidationResultRelationService.Validator. validateCreate(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Validate create operation<S extends Relatable,T extends Relatable>
ValidationResultRelationService.Validator. validateDelete(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Validate delete operation<S extends Relatable,T extends Relatable>
ValidationResultRelationService.Validator. validateDeleteAllWithType(Relatable relatable, RelationDescriptor<S,T> relationDescriptor)
Validate the delete all operation<S extends Relatable,T extends Relatable>
ValidationResultRelationService.Validator. validateFetch(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Validate fetch operation to check whether a user can view the specifed relation -
Uses of RelationDescriptor in com.atlassian.confluence.internal.relations
Methods in com.atlassian.confluence.internal.relations with parameters of type RelationDescriptor Modifier and Type Method Description RelationEntity
DefaultRelationManager. addRelation(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
RelationEntity
RelationManager. addRelation(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
Create a new relation between 2 entities.static RelationshipTypeEnum
RelationshipTypeEnum. getRelationshipType(RelationDescriptor<?,?> relationDescriptor)
Returns type of relationship based on relation descriptor.static RelationshipTypeEnum
RelationshipTypeEnum. getRelationshipType(RelationDescriptor<?,?> relationDescriptor, boolean throwOnError)
Returns type of relationship based on relation descriptor.boolean
DefaultRelationManager. isRelated(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
boolean
RelationManager. isRelated(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
Checks if given entities are related.void
DefaultRelationManager. moveRelationsToContent(RelatableEntity fromRelatableEntity, RelatableEntity toRelatableEntity, RelationDescriptor descriptor)
void
RelationManager. moveRelationsToContent(RelatableEntity fromRelatableEntity, RelatableEntity toRelatableEntity, RelationDescriptor descriptor)
Moves all the relations of the specified type from one entity to another.int
DefaultRelationManager. removeAllRelationsFromEntityWithType(RelationDescriptor relationDescriptor, RelatableEntity relatableEntity)
int
RelationManager. removeAllRelationsFromEntityWithType(RelationDescriptor relationDescriptor, RelatableEntity relatableEntity)
This method remove all relations of the given type where the given entity participatesvoid
DefaultRelationManager. removeRelation(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
void
RelationManager. removeRelation(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
Delete relation.static ValidationResult
RelationUtils. validateAgainstApiModel(RelatableEntity source, RelatableEntity target, RelationDescriptor relationDescriptor)
Helper method, which can be used to validate relation based on input parameters. -
Uses of RelationDescriptor in com.atlassian.confluence.internal.relations.dao
Methods in com.atlassian.confluence.internal.relations.dao with parameters of type RelationDescriptor Modifier and Type Method Description RelationEntity<S,T>
RelationDao. createRelationEntity(S source, T target, RelationDescriptor<?,?> relationDescriptor)
Create new relation.@Nullable RelationEntity<S,T>
RelationDao. getRelationEntity(S source, T target, RelationDescriptor<?,?> relationDescriptor)
Get relation for given content, type and name.int
RelationDao. getRelationsCount(S source, T target, RelationDescriptor<?,?> relationDescriptor)
Get total number of relations for given content, type and name. -
Uses of RelationDescriptor in com.atlassian.confluence.internal.relations.dao.hibernate
Methods in com.atlassian.confluence.internal.relations.dao.hibernate with parameters of type RelationDescriptor Modifier and Type Method Description protected RelationEntity<S,T>
HibernateRelationDao. constructRelationEntity(RelationEntity<S,T> relationEntity, S source, T target, RelationDescriptor<?,?> relationDescriptor)
protected RelationEntity<ConfluenceUser,ContentEntityObject>
User2ContentHibernateRelationDao. constructRelationEntity(RelationEntity<ConfluenceUser,ContentEntityObject> relationEntity, ConfluenceUser source, ContentEntityObject target, RelationDescriptor<?,?> relationDescriptor)
RelationEntity<S,T>
HibernateRelationDao. createRelationEntity(S source, T target, RelationDescriptor<?,?> relationDescriptor)
protected @NonNull List<RelationEntity<S,T>>
HibernateRelationDao. getRelationEntities(String queryName, S source, T target, RelationDescriptor<?,?> relationDescriptor)
@Nullable Content2ContentRelationEntity
Content2ContentHibernateRelationDao. getRelationEntity(ContentEntityObject source, ContentEntityObject target, RelationDescriptor<?,?> relationDescriptor)
@Nullable User2ContentRelationEntity
User2ContentHibernateRelationDao. getRelationEntity(ConfluenceUser source, ContentEntityObject target, RelationDescriptor<?,?> relationDescriptor)
@Nullable User2UserRelationEntity
User2UserHibernateRelationDao. getRelationEntity(ConfluenceUser source, ConfluenceUser target, RelationDescriptor<?,?> relationDescriptor)
int
Content2ContentHibernateRelationDao. getRelationsCount(ContentEntityObject source, ContentEntityObject target, RelationDescriptor<?,?> relationDescriptor)
int
User2ContentHibernateRelationDao. getRelationsCount(ConfluenceUser source, ContentEntityObject target, RelationDescriptor<?,?> relationDescriptor)
int
User2UserHibernateRelationDao. getRelationsCount(ConfluenceUser source, ConfluenceUser target, RelationDescriptor<?,?> relationDescriptor)
-
Uses of RelationDescriptor in com.atlassian.confluence.internal.relations.query
Methods in com.atlassian.confluence.internal.relations.query that return RelationDescriptor Modifier and Type Method Description RelationDescriptor<?,?>
RelationQuery. getRelationDescriptor()
Methods in com.atlassian.confluence.internal.relations.query with parameters of type RelationDescriptor Modifier and Type Method Description static <E extends RelatableEntity>
RelationQuery.BuilderRelationQuery. create(@NonNull E entity, @NonNull RelationDescriptor relationDescriptor)
RelationQuery.Builder
RelationQuery.Builder. relation(@NonNull RelationDescriptor<?,?> relationDescriptor)
Constructors in com.atlassian.confluence.internal.relations.query with parameters of type RelationDescriptor Constructor Description Builder(@NonNull R entity, @NonNull RelationDescriptor<?,?> relationDescriptor)
-
Uses of RelationDescriptor in com.atlassian.confluence.rest.client
Methods in com.atlassian.confluence.rest.client with parameters of type RelationDescriptor Modifier and Type Method Description <S extends Relatable,T extends Relatable>
com.atlassian.util.concurrent.Promise<Boolean>RemoteRelationService. isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Deprecated.since 7.0.1.<S extends Relatable,T extends Relatable>
CompletionStage<Boolean>RemoteRelationService. isRelatedCompletionStage(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Determine whether a given source and target are related by the given relation -
Uses of RelationDescriptor in com.atlassian.confluence.rest.client.impl
Methods in com.atlassian.confluence.rest.client.impl with parameters of type RelationDescriptor Modifier and Type Method Description <S extends Relatable,T extends Relatable>
com.atlassian.util.concurrent.Promise<Boolean>RemoteRelationServiceImpl. isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
Deprecated.since 7.0.1.<S extends Relatable,T extends Relatable>
CompletionStage<Boolean>RemoteRelationServiceImpl. isRelatedCompletionStage(S source, RelationDescriptor<S,T> relationDescriptor, T target)
-