net.rcarz.jiraclient

Class Issue.FluentRemoteLink

java.lang.Object

net.rcarz.jiraclient.Issue.FluentRemoteLink

Enclosing class:

Issue

public static final class Issue.FluentRemoteLink
extends Object

Used to create remote links. Provide at least the url(String) or global id and the title.

Method Summary

Modifier and Type	Method and Description
Issue.FluentRemoteLink	application(String type, String name) The application for this remote link.
void	create() Creates or updates the remote link if a global id is given and there is already a remote link for the specified global id.
Issue.FluentRemoteLink	globalId(String globalId) A globally unique identifier which uniquely identifies the remote application and the remote object within the remote system.
Issue.FluentRemoteLink	icon(String url, String title) Provide an icon for the remote link.
Issue.FluentRemoteLink	relationship(String relationship) Relationship between the remote object and the JIRA issue.
Issue.FluentRemoteLink	status(boolean resolved, String iconUrl, String title, String statusUrl) The status in the remote system.
Issue.FluentRemoteLink	summary(String summary) Textual summary of the remote object.
Issue.FluentRemoteLink	title(String title) The title of the remote object.
Issue.FluentRemoteLink	url(String url) A hyperlink to the object in the remote system.

Methods inherited from class java.lang.Object

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

Method Detail

globalId

public Issue.FluentRemoteLink globalId(String globalId)

A globally unique identifier which uniquely identifies the remote application and the remote object within the remote system. The maximum length is 255 characters. This call sets also the url.

Parameters:

globalId - the global id

Returns:

this instance

url

public Issue.FluentRemoteLink url(String url)

A hyperlink to the object in the remote system.

Parameters:

url - A hyperlink to the object in the remote system.

Returns:

this instance

title

public Issue.FluentRemoteLink title(String title)

The title of the remote object.

Parameters:

title - The title of the remote object.

Returns:

this instance

icon

public Issue.FluentRemoteLink icon(String url,
                                   String title)

Provide an icon for the remote link.

Parameters:

url - A 16x16 icon representing the type of the object in the remote system.

title - Text for the tooltip of the main icon describing the type of the object in the remote system.

Returns:

this instance

status

public Issue.FluentRemoteLink status(boolean resolved,
                                     String iconUrl,
                                     String title,
                                     String statusUrl)

The status in the remote system.

Parameters:

resolved - if true the link to the issue will be in a strike through font.

title - Text for the tooltip of the main icon describing the type of the object in the remote system.

iconUrl - Text for the tooltip of the main icon describing the type of the object in the remote system.

statusUrl - A hyperlink for the tooltip of the the status icon.

Returns:

this instance

summary

public Issue.FluentRemoteLink summary(String summary)

Textual summary of the remote object.

Parameters:

summary - Textual summary of the remote object.

Returns:

this instance

relationship

public Issue.FluentRemoteLink relationship(String relationship)

Relationship between the remote object and the JIRA issue. This can be a verb or a noun. It is used to group together links in the UI.

Parameters:

relationship - Relationship between the remote object and the JIRA issue.

Returns:

this instance

application

public Issue.FluentRemoteLink application(String type,
                                          String name)

The application for this remote link. Links are grouped on the type and name in the UI. The name-spaced type of the application. It is not displayed to the user. Renderering plugins can register to render a certain type of application.

Parameters:

type - The name-spaced type of the application.

name - The human-readable name of the remote application instance that stores the remote object.

Returns:

this instance

create

public void create()
            throws JiraException

Creates or updates the remote link if a global id is given and there is already a remote link for the specified global id.

Throws:

JiraException - when the remote link creation fails