|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.event.issue.AbstractIssueEventListener
Subclasses of IssueEventListener can now override relevant functions in the interface as opposed to having to provide a dummy implementation for all methods.
Constructor Summary | |
AbstractIssueEventListener()
|
Method Summary | |
java.lang.String[] |
getAcceptedParams()
Get a list of the parameters for this listener. |
java.lang.String |
getDescription()
A textual description of the listener. |
void |
init(java.util.Map params)
Initialise the listener. |
boolean |
isInternal()
Indicates whether administrators can delete this listener from within the web interface. |
void |
issueAssigned(IssueEvent event)
Fired when an issue is assigned or unassigned. |
void |
issueClosed(IssueEvent event)
Fired when an issue is closed. |
void |
issueCommented(IssueEvent event)
Fired when a user comments on an issue. |
void |
issueCreated(IssueEvent event)
Fired when an issue is created. |
void |
issueDeleted(IssueEvent event)
Fired when an issue is deleted. |
void |
issueReopened(IssueEvent event)
Fired when an issue is reopened. |
void |
issueResolved(IssueEvent event)
Fired when an issue is resolved. |
void |
issueStarted(IssueEvent event)
Fired when user starts work on an issue (start progress) |
void |
issueStopped(IssueEvent event)
Fired when user stops work on an issue (stop progress) |
void |
issueUpdated(IssueEvent event)
Fired when an issue is updated. |
void |
issueWorkLogged(IssueEvent event)
Fired when work is logged against an issue. |
boolean |
isUnique()
Whether this listener class should be unique. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractIssueEventListener()
Method Detail |
public void issueCreated(IssueEvent event)
IssueEventListener
issueCreated
in interface IssueEventListener
public void issueUpdated(IssueEvent event)
IssueEventListener
The update changelog will be attached to the event as an action.
issueUpdated
in interface IssueEventListener
public void issueAssigned(IssueEvent event)
IssueEventListener
Check the issue assignee to work out which is the case.
issueAssigned
in interface IssueEventListener
public void issueResolved(IssueEvent event)
IssueEventListener
The resolution comment (if there is one) will be attached to the event as an action.
issueResolved
in interface IssueEventListener
public void issueClosed(IssueEvent event)
IssueEventListener
The closure comment (if there is one) will be attached to the event as an action.
issueClosed
in interface IssueEventListener
public void issueCommented(IssueEvent event)
IssueEventListener
The comment will be attached to the event as an action.
issueCommented
in interface IssueEventListener
public void issueReopened(IssueEvent event)
IssueEventListener
issueReopened
in interface IssueEventListener
public void issueDeleted(IssueEvent event)
IssueEventListener
issueDeleted
in interface IssueEventListener
public void issueWorkLogged(IssueEvent event)
IssueEventListener
The work log will be attached to the event as an action.
issueWorkLogged
in interface IssueEventListener
public void init(java.util.Map params)
JiraListener
For custom listeners, the list of parameters is always empty.
init
in interface JiraListener
public java.lang.String[] getAcceptedParams()
JiraListener
getAcceptedParams
in interface JiraListener
public boolean isInternal()
JiraListener
Basically only Atlassian listeners should return true from this.
isInternal
in interface JiraListener
public boolean isUnique()
JiraListener
Having multiple mail listeners could be fine - if you wanted multiple mails sent out.
With other listeners, such as the cache listeners, it makes no sense to have multiple listeners of the one class.
isUnique
in interface JiraListener
public java.lang.String getDescription()
JiraListener
A good description will describe what this listener does, and then explains the parameters required for configuring the listener.
If no description is appropriate, return null.
getDescription
in interface JiraListener
public void issueStarted(IssueEvent event)
IssueEventListener
issueStarted
in interface IssueEventListener
public void issueStopped(IssueEvent event)
IssueEventListener
issueStopped
in interface IssueEventListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |