com.atlassian.confluence.api.service.relations

Interface RelationService.RelationFinder<S extends Relatable,T extends Relatable>

Type Parameters:

S -

T -

All Superinterfaces:

ManyFetcher<RelationInstance<S,T>>, SingleFetcher<RelationInstance<S,T>>

Enclosing interface:

RelationService

public static interface RelationService.RelationFinder<S extends Relatable,T extends Relatable>
extends ManyFetcher<RelationInstance<S,T>>, SingleFetcher<RelationInstance<S,T>>

Finder which fetches relation instances, this is useful for getting data that is associated with a relation.

Currently both one of a source or source class and a target or targetClass is required.

Method Summary

Modifier and Type	Method and Description
RelationService.RelationFinder<S,T>	fromSource(S source) Apply a filter that restricts the returned relations to those that have the given entity as the source of the relation
RelationService.RelationFinder<S,T>	fromSourceClass(Class<S> sourceClass) Apply a filter that restricts the returned relations to those that have the given class as a source type.
RelationService.RelationFinder<S,T>	toTarget(T target) Apply a filter that restricts the returned relations to those that have the given entity as the target of the relation
RelationService.RelationFinder<S,T>	toTargetClass(Class<T> targetClass) Apply a filter that restricts the returned relations to those that have the given class as a target type.
RelationService.RelationFinder<S,T>	withName(String name) Apply a filter that restricts the returned relations to those with the given name

Methods inherited from interface com.atlassian.confluence.api.service.finder.ManyFetcher

fetchMany

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetchOne, fetchOneOrNull

Method Detail

toTargetClass

RelationService.RelationFinder<S,T> toTargetClass(Class<T> targetClass)

Apply a filter that restricts the returned relations to those that have the given class as a target type.

Parameters:

targetClass -

Returns:

this

fromSourceClass

RelationService.RelationFinder<S,T> fromSourceClass(Class<S> sourceClass)

Apply a filter that restricts the returned relations to those that have the given class as a source type.

Parameters:

sourceClass -

Returns:

this

toTarget

RelationService.RelationFinder<S,T> toTarget(T target)

Apply a filter that restricts the returned relations to those that have the given entity as the target of the relation

Parameters:

target -

Returns:

this

fromSource

RelationService.RelationFinder<S,T> fromSource(S source)

Apply a filter that restricts the returned relations to those that have the given entity as the source of the relation

Parameters:

source -

Returns:

this

withName

RelationService.RelationFinder<S,T> withName(String name)

Apply a filter that restricts the returned relations to those with the given name

Parameters:

name -

Returns:

this