Uses of Interface
com.atlassian.confluence.api.model.relations.Relatable

Packages that use Relatable

Package	Description
com.atlassian.confluence.api.impl.service.relation
com.atlassian.confluence.api.model.content
com.atlassian.confluence.api.model.people
com.atlassian.confluence.api.model.relations
com.atlassian.confluence.api.nav
com.atlassian.confluence.api.service.relations
com.atlassian.confluence.plugins.rest.navigation.impl
com.atlassian.confluence.plugins.restapi.experimental.resources
com.atlassian.confluence.plugins.restapi.resources
com.atlassian.confluence.rest.client
com.atlassian.confluence.rest.client.impl

Uses of Relatable in com.atlassian.confluence.api.impl.service.relation

Classes in com.atlassian.confluence.api.impl.service.relation with type parameters of type Relatable

Modifier and Type	Class and Description
class	AuthenticatedUserRelationDescriptor<S extends User,T extends Relatable> A ValidatingRelationDescriptor which checks that the User for which the relation is being created is also the currently authenticated user.
class	DefaultValidatingRelationDescriptor<S extends Relatable,T extends Relatable>
class	DefaultValidatingRelationDescriptor<S extends Relatable,T extends Relatable>
class	RelatableFactory<S extends RelatableEntity,T extends Relatable>

Methods in com.atlassian.confluence.api.impl.service.relation with type parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> RelationInstance<S,T>	RelationServiceImpl.create(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> RelationInstance<S,T>	RelationServiceImpl.create(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> void	RelationServiceImpl.delete(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> void	RelationServiceImpl.delete(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> RelationService.RelationFinder<S,T>	RelationServiceImpl.find(Expansion... expansions)
<S extends Relatable,T extends Relatable> RelationService.RelationFinder<S,T>	RelationServiceImpl.find(Expansion... expansions)
<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<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> RelationService.RelatableFinder<T>	RelationServiceImpl.findTargets(S source, RelationDescriptor<S,T> relationDescriptor)
<S extends Relatable,T extends Relatable> boolean	RelationServiceImpl.isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
<S extends Relatable,T extends Relatable> boolean	RelationServiceImpl.isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
<S extends Relatable,T extends Relatable> void	RelationServiceImpl.removeAllRelationsFromEntityWithType(RelationDescriptor<S,T> relationDescriptor, Relatable relatable)
<S extends Relatable,T extends Relatable> void	RelationServiceImpl.removeAllRelationsFromEntityWithType(RelationDescriptor<S,T> relationDescriptor, Relatable relatable)

Methods in com.atlassian.confluence.api.impl.service.relation with parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> void	RelationServiceImpl.removeAllRelationsFromEntityWithType(RelationDescriptor<S,T> relationDescriptor, Relatable relatable)
RelatableEntity	RelatableResolver.resolve(Relatable relatable)

Uses of Relatable in com.atlassian.confluence.api.model.content

Classes in com.atlassian.confluence.api.model.content that implement Relatable

Modifier and Type	Class and Description
class	Content Represents all the different kinds of content that can be housed in Confluence: pages, blog posts, comments and so on.
class	Space Representation of a Confluence Space.

Uses of Relatable in com.atlassian.confluence.api.model.people

Classes in com.atlassian.confluence.api.model.people that implement Relatable

Modifier and Type	Class and Description
class	KnownUser
class	UnknownUser
class	User

Uses of Relatable in com.atlassian.confluence.api.model.relations

Classes in com.atlassian.confluence.api.model.relations with type parameters of type Relatable

Modifier and Type	Class and 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	AbstractRelationDescriptor<S extends Relatable,T extends Relatable> Relation descriptor, which should be used as a base class for all custom relation descriptors.
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 of RelationDescriptor, which allows to create simple named relation descriptors.
class	NamedRelationDescriptor<S extends Relatable,T extends Relatable> Simple implementation of RelationDescriptor, which allows to create simple named relation descriptors.
interface	RelationDescriptor<S extends Relatable,T extends Relatable> Defines relation name, type and who may have such relations.
interface	RelationDescriptor<S extends Relatable,T extends Relatable> Defines relation name, type and who may have such relations.
class	RelationInstance<S extends Relatable,T extends Relatable> Represents a named relation between two entities
class	RelationInstance<S extends Relatable,T extends Relatable> Represents a named relation between two entities
static class	RelationInstance.RelationInstanceBuilder<S extends Relatable,T extends Relatable>
static class	RelationInstance.RelationInstanceBuilder<S extends Relatable,T extends Relatable>
interface	ValidatingRelationDescriptor<S extends Relatable,T extends Relatable> A RelationDescriptor which provides a method to perform validation on descriptor operations.
interface	ValidatingRelationDescriptor<S extends Relatable,T extends Relatable> A RelationDescriptor which provides a method to perform validation on descriptor operations.

Methods in com.atlassian.confluence.api.model.relations with type parameters of type Relatable

Modifier and Type	Method and Description
static <S extends Relatable,T extends Relatable> RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.builder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)
static <S extends Relatable,T extends Relatable> RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.builder(Reference<S> sourceRef, RelationDescriptor<S,T> relationDescriptor, Reference<T> targetRef)
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> RelationInstance.RelationInstanceBuilder<S,T>	RelationInstance.builder(S source, RelationDescriptor<S,T> relationDescriptor, T target)
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).
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).

Uses of Relatable in com.atlassian.confluence.api.nav

Method parameters in com.atlassian.confluence.api.nav with type arguments of type Relatable

Modifier and Type	Method and Description
Navigation.RelationToNav	Navigation.RelationFromNav.from(Reference<? extends Relatable> reference)
Navigation.Builder	Navigation.RelationToNav.to(Class<? extends Relatable> targetClass)
Navigation.Builder	Navigation.RelationToNav.to(Reference<? extends Relatable> reference)

Uses of Relatable in com.atlassian.confluence.api.service.relations

Classes in com.atlassian.confluence.api.service.relations with type parameters of type Relatable

Modifier and Type	Interface and Description
static interface	RelationService.RelatableFinder<R extends Relatable> Finder, which is used to perform basic relation operations, such as fetching source or target entities of particular relation, get total number of related entities etc.
static interface	RelationService.RelationFinder<S extends Relatable,T extends Relatable> Finder which fetches relation instances, this is useful for getting data that is associated with a relation.
static interface	RelationService.RelationFinder<S extends Relatable,T extends Relatable> Finder which fetches relation instances, this is useful for getting data that is associated with a relation.

Methods in com.atlassian.confluence.api.service.relations with type parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> RelationInstance<S,T>	RelationService.create(RelationInstance<S,T> relationInstance) Creates a directed relation between two relatable entities.
<S extends Relatable,T extends Relatable> RelationInstance<S,T>	RelationService.create(RelationInstance<S,T> relationInstance) Creates a directed relation between two relatable entities.
<S extends Relatable,T extends Relatable> void	RelationService.delete(RelationInstance<S,T> relationInstance) Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable,T extends Relatable> void	RelationService.delete(RelationInstance<S,T> relationInstance) Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable,T extends Relatable> RelationService.RelationFinder<S,T>	RelationService.find(Expansion... expansions) Creates a finder to find relation instances.
<S extends Relatable,T extends Relatable> RelationService.RelationFinder<S,T>	RelationService.find(Expansion... expansions) Creates a finder to find relation instances.
<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<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> 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> boolean	RelationService.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> boolean	RelationService.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> void	RelationService.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> void	RelationService.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> ValidationResult	RelationService.Validator.validateCreate(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate create operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateCreate(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate create operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateDelete(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate delete operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateDelete(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate delete operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateDeleteAllWithType(Relatable relatable, RelationDescriptor<S,T> relationDescriptor) Validate the delete all operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateDeleteAllWithType(Relatable relatable, RelationDescriptor<S,T> relationDescriptor) Validate the delete all operation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateFetch(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate fetch operation to check whether a user can view the specifed relation
<S extends Relatable,T extends Relatable> ValidationResult	RelationService.Validator.validateFetch(S source, RelationDescriptor<S,T> relationDescriptor, T target) Validate fetch operation to check whether a user can view the specifed relation

Methods in com.atlassian.confluence.api.service.relations with parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> void	RelationService.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> ValidationResult	RelationService.Validator.validateDeleteAllWithType(Relatable relatable, RelationDescriptor<S,T> relationDescriptor) Validate the delete all operation

Uses of Relatable in com.atlassian.confluence.plugins.rest.navigation.impl

Method parameters in com.atlassian.confluence.plugins.rest.navigation.impl with type arguments of type Relatable

Modifier and Type	Method and Description
Navigation.RelationToNav	RelationNavImpl.from(Reference<? extends Relatable> reference)
RelationNavImpl	RelationNavImpl.to(Class<? extends Relatable> targetClass)
Navigation.Builder	RelationNavImpl.to(Reference<? extends Relatable> reference)

Uses of Relatable in com.atlassian.confluence.plugins.restapi.experimental.resources

Methods in com.atlassian.confluence.plugins.restapi.experimental.resources that return types with arguments of type Relatable

Modifier and Type	Method and Description
PageResponse<RelationInstance<Relatable,Relatable>>	ExperimentalRelationResource.findSourcesForTarget(String relationName, String targetType, String targetKey, String sourceType, ContentStatus targetStatus, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances to the given target entity that have a relation with the relation name from the source type
PageResponse<RelationInstance<Relatable,Relatable>>	ExperimentalRelationResource.findSourcesForTarget(String relationName, String targetType, String targetKey, String sourceType, ContentStatus targetStatus, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances to the given target entity that have a relation with the relation name from the source type
PageResponse<RelationInstance<Relatable,Relatable>>	ExperimentalRelationResource.findTargetFromSource(String sourceType, String sourceKey, String relationName, String targetType, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances of the given target type that have a relation with the relation name from the source entity
PageResponse<RelationInstance<Relatable,Relatable>>	ExperimentalRelationResource.findTargetFromSource(String sourceType, String sourceKey, String relationName, String targetType, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances of the given target type that have a relation with the relation name from the source entity

Uses of Relatable in com.atlassian.confluence.plugins.restapi.resources

Methods in com.atlassian.confluence.plugins.restapi.resources that return types with arguments of type Relatable

Modifier and Type	Method and Description
RelationInstance<Relatable,Relatable>	RelationResource.create(String sourceType, String sourceKey, String relationName, String targetType, String targetKey, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion) Add a relationship between two user, space, or content entities.
RelationInstance<Relatable,Relatable>	RelationResource.create(String sourceType, String sourceKey, String relationName, String targetType, String targetKey, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion) Add a relationship between two user, space, or content entities.
PageResponse<RelationInstance<Relatable,Relatable>>	RelationResource.findSourcesForTarget(String relationName, String targetType, String targetKey, String sourceType, ContentStatus targetStatus, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances to the given target entity that have a relation with the relation name from the source type
PageResponse<RelationInstance<Relatable,Relatable>>	RelationResource.findSourcesForTarget(String relationName, String targetType, String targetKey, String sourceType, ContentStatus targetStatus, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances to the given target entity that have a relation with the relation name from the source type
PageResponse<RelationInstance<Relatable,Relatable>>	RelationResource.findTargetFromSource(String sourceType, String sourceKey, String relationName, String targetType, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances of the given target type that have a relation with the relation name from the source entity
PageResponse<RelationInstance<Relatable,Relatable>>	RelationResource.findTargetFromSource(String sourceType, String sourceKey, String relationName, String targetType, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo) Find relation instances of the given target type that have a relation with the relation name from the source entity
RelationInstance<Relatable,Relatable>	RelationResource.isRelated(String sourceType, String sourceKey, String relationName, String targetType, String targetKey, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand) Determines whether a relationship exists between two user, space or content entities.
RelationInstance<Relatable,Relatable>	RelationResource.isRelated(String sourceType, String sourceKey, String relationName, String targetType, String targetKey, ContentStatus sourceStatus, ContentStatus targetStatus, Integer sourceVersion, Integer targetVersion, String expand) Determines whether a relationship exists between two user, space or content entities.

Uses of Relatable in com.atlassian.confluence.rest.client

Methods in com.atlassian.confluence.rest.client with type parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationService.create(RelationInstance<S,T> relationInstance) Creates a directed relation between two relatable entities.
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationService.create(RelationInstance<S,T> relationInstance) Creates a directed relation between two relatable entities.
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationService.delete(RelationInstance<S,T> relationInstance) Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationService.delete(RelationInstance<S,T> relationInstance) Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Boolean>	RemoteRelationService.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> com.atlassian.util.concurrent.Promise<Boolean>	RemoteRelationService.isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target) Determine whether a given source and target are related by the given relation

Uses of Relatable in com.atlassian.confluence.rest.client.impl

Methods in com.atlassian.confluence.rest.client.impl with type parameters of type Relatable

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationServiceImpl.create(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationServiceImpl.create(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationServiceImpl.delete(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	RemoteRelationServiceImpl.delete(RelationInstance<S,T> relationInstance)
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Boolean>	RemoteRelationServiceImpl.isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Boolean>	RemoteRelationServiceImpl.isRelated(S source, RelationDescriptor<S,T> relationDescriptor, T target)