com.almworks.jira.structure.api.job
Interface StructureJobFeedback

public interface StructureJobFeedback

StructureJobFeedback allows communication between job owner, job itself and the visual components that display the job information.

If you know jobId, you can access its feedback using StructureJobManager.getFeedback(java.lang.Long) method.

This feature is under-developed yet. This interface is likely to change soon as we provide more and better ways to report progress and other information to the user.

Author:

Igor Sereda

Method Summary

StructureJobFeedback	addButton(String buttonText, String link) Adds a button to the feedback screen that brings the user to the specified link.
StructureJobFeedback	addManagingUser(com.atlassian.crowd.embedded.api.User user) By default, only the owner of the job may see the feedback.
boolean	isVisibleTo(com.atlassian.crowd.embedded.api.User user) Checks if this feedback is visible to the specified user.
StructureJobFeedback	setI18nFactory(com.atlassian.jira.util.I18nHelper.BeanFactory i18nFactory)
StructureJobFeedback	setJobName(String key, Object... arguments) Sets the name of the job.

Method Detail

addButton

StructureJobFeedback addButton(String buttonText,
                               String link)

Adds a button to the feedback screen that brings the user to the specified link.

Parameters:

buttonText - text on the button

link - link address

Returns:

this instance

setJobName

StructureJobFeedback setJobName(String key,
                                Object... arguments)

Sets the name of the job.

Parameters:

key - i18n key of the job name

arguments - arguments for creating a text message

Returns:

this instance

setI18nFactory

StructureJobFeedback setI18nFactory(com.atlassian.jira.util.I18nHelper.BeanFactory i18nFactory)

addManagingUser

StructureJobFeedback addManagingUser(com.atlassian.crowd.embedded.api.User user)

By default, only the owner of the job may see the feedback. Call this method to allow another user to view the feedback as well.

Parameters:

user - the user that is allowed to view the feedback

Returns:

this instance

isVisibleTo

boolean isVisibleTo(com.atlassian.crowd.embedded.api.User user)

Checks if this feedback is visible to the specified user.

Parameters:

user - the user to check

Returns:

true if the user is allowed to see the feedback