|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityLinkService
Provides methods for retrieving entities from linked applications that are associated with local entities (e.g. JIRA projects, Confluence spaces, etc.).
The Object
typed first parameters of this interface's methods are Strings and/or domain objects that
represent project entities from the API of each Atlassian host application. This is specific to each application
that the Unified Application Links plugin is deployed to.
For example, in FishEye/Crucible:
Is equivalent to:RepositoryHandle repHandle = repositoryManager.getRepository("my-source");Iterable
<EntityLink
> entityLinkService.getEntityLinks(java.lang.Object, java.lang.Class extends com.atlassian.applinks.api.EntityType>)
(repHandle);
Both will return anRepsoitoryData repData = repositoryService.getRepository("my-source");Iterable
<EntityLink
> entityLinkService.getEntityLinks(java.lang.Object, java.lang.Class extends com.atlassian.applinks.api.EntityType>)
(repData);
Iterable
of EntityLink
s that are linked from the "my-source" FishEye repository.
Whereas:
will return anProject project = projectManager.getProjectByKey("CR-MYSRC");Iterable
<EntityLink
> entityLinkService.getEntityLinks(java.lang.Object, java.lang.Class extends com.atlassian.applinks.api.EntityType>)
(project);
Iterable
of EntityLink
s that are linked from the CR-MYSRC FishEye/Crucible project.
In JIRA and Confluence, where there is only one type of entity which can be linked, you can instead simply provide a String identifier for the entity, for example:
will return anIterable
<EntityLink
> entityLinkService.getEntityLinks(java.lang.Object, java.lang.Class extends com.atlassian.applinks.api.EntityType>)
("JRA");
Iterable
of EntityLink
s that are linked from the JRA JIRA project.
Method Summary | |
---|---|
java.lang.Iterable<EntityLink> |
getEntityLinks(java.lang.Object entity)
|
java.lang.Iterable<EntityLink> |
getEntityLinks(java.lang.Object entity,
java.lang.Class<? extends EntityType> type)
|
EntityLink |
getPrimaryEntityLink(java.lang.Object entity,
java.lang.Class<? extends EntityType> type)
There are exactly zero or one primary EntityLink s of each type configured for each local entity. |
Method Detail |
---|
java.lang.Iterable<EntityLink> getEntityLinks(java.lang.Object entity, java.lang.Class<? extends EntityType> type)
entity
- an application specific entity domain object, see class javadoc for more detailstype
- the type of EntityLink
s to retrieve (e.g. fisheye-repository)
Iterable
containing EntityLink
s associated with the specified entity, of the specified typejava.lang.Iterable<EntityLink> getEntityLinks(java.lang.Object entity)
entity
- an application specific entity domain object, see class javadoc for more details
Iterable
containing EntityLink
s associated with the specified entityEntityLink getPrimaryEntityLink(java.lang.Object entity, java.lang.Class<? extends EntityType> type)
EntityLink
s of each type configured for each local entity.
If any links of the specified type exist, exactly one of them will be primary.
entity
- an application specific entity domain object, see class javadoc for more detailstype
- the type of primary EntityLink
to retrieve (e.g. fisheye-repository)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |