|
||||||||||
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
public abstract class 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 | |
---|---|
void |
customEvent(IssueEvent event)
Implement this method to deal with any custom events within the system |
String[] |
getAcceptedParams()
Get a list of the parameters for this listener. |
String |
getDescription()
A textual description of the listener. |
protected I18nHelper |
getI18NBean()
|
void |
init(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 |
issueCommentEdited(IssueEvent event)
|
void |
issueCreated(IssueEvent event)
Fired when an issue is created. |
void |
issueDeleted(IssueEvent event)
Fired when an issue is deleted. |
void |
issueGenericEvent(IssueEvent event)
Fired for all other events, eg. |
void |
issueMoved(IssueEvent event)
Fired when an issue is moved. |
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 |
issueWorklogDeleted(IssueEvent event)
|
void |
issueWorkLogged(IssueEvent event)
Fired when work is logged against an issue. |
void |
issueWorklogUpdated(IssueEvent event)
|
boolean |
isUnique()
Whether this listener class should be unique. |
void |
workflowEvent(IssueEvent event)
Determines how the event should be processed. |
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
issueUpdated
in interface IssueEventListener
public void issueAssigned(IssueEvent event)
IssueEventListener
issueAssigned
in interface IssueEventListener
public void issueResolved(IssueEvent event)
IssueEventListener
issueResolved
in interface IssueEventListener
public void issueClosed(IssueEvent event)
IssueEventListener
issueClosed
in interface IssueEventListener
public void issueCommented(IssueEvent event)
IssueEventListener
issueCommented
in interface IssueEventListener
public void issueCommentEdited(IssueEvent event)
public void issueWorklogUpdated(IssueEvent event)
public void issueWorklogDeleted(IssueEvent event)
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
issueWorkLogged
in interface IssueEventListener
public void issueStarted(IssueEvent event)
IssueEventListener
issueStarted
in interface IssueEventListener
public void issueStopped(IssueEvent event)
IssueEventListener
issueStopped
in interface IssueEventListener
public void issueMoved(IssueEvent event)
IssueEventListener
issueMoved
in interface IssueEventListener
public void issueGenericEvent(IssueEvent event)
IssueEventListener
issueGenericEvent
in interface IssueEventListener
public void workflowEvent(IssueEvent event)
An event with an unknown event type ID is logged and discarded.
The customEvent method should be implemented to deal with any custom events that are added to the system
workflowEvent
in interface IssueEventListener
event
- - the IssueEvent object containing the event type IDpublic void customEvent(IssueEvent event)
customEvent
in interface IssueEventListener
event
- public void init(Map params)
JiraListener
For custom listeners, the list of parameters is always empty.
init
in interface JiraListener
public 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 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
protected I18nHelper getI18NBean()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |