public interface

ShareService

com.atlassian.jira.plugins.share.ShareService
Known Indirect Subclasses

Class Overview

Shares entities such as issues, saved searches or unsaved searches via e-mail.

Summary

Nested Classes
class ShareService.ValidateShareIssueResult  
class ShareService.ValidateShareResult  
class ShareService.ValidateShareSearchRequestResult  
Public Methods
void shareIssue(ShareService.ValidateShareIssueResult result)
Given a valid ValidateShareIssueResult this method will send an e-mail to the users and fire a ShareIssueEvent
void shareSearchRequest(ShareService.ValidateShareSearchRequestResult result)
Given a valid ValidateShareIssueResult this method will send an e-mail to the users and fire a ShareJqlEvent or ShareSearchRequestEvent depending on if a saved filter was passed to the validate method.
ShareService.ValidateShareIssueResult validateShareIssue(ApplicationUser remoteUser, ShareBean shareBean, Issue issue)
Confirms that the shareBean param contains either usernames or e-mails and also validates that the user performing this operation has the permission to view other users in this JIRA instance.
ShareService.ValidateShareSearchRequestResult validateShareSearchRequest(ApplicationUser remoteUser, ShareBean shareBean, SearchRequest searchRequest)
Confirms that the shareRequest param contains either usernames or e-mails and also validates that the user performing this operation has the permission to view other users in this JIRA instance.

Public Methods

public void shareIssue (ShareService.ValidateShareIssueResult result)

Given a valid ValidateShareIssueResult this method will send an e-mail to the users and fire a ShareIssueEvent

Parameters
result a valid validateShareIssueResult.

public void shareSearchRequest (ShareService.ValidateShareSearchRequestResult result)

Given a valid ValidateShareIssueResult this method will send an e-mail to the users and fire a ShareJqlEvent or ShareSearchRequestEvent depending on if a saved filter was passed to the validate method.

Parameters
result a valid validateShareIssueResult.

public ShareService.ValidateShareIssueResult validateShareIssue (ApplicationUser remoteUser, ShareBean shareBean, Issue issue)

Confirms that the shareBean param contains either usernames or e-mails and also validates that the user performing this operation has the permission to view other users in this JIRA instance.

Parameters
remoteUser The user performing the share operation
shareBean Bean containing information about who to share with
issue The issue being shared
Returns
  • A service result

public ShareService.ValidateShareSearchRequestResult validateShareSearchRequest (ApplicationUser remoteUser, ShareBean shareBean, SearchRequest searchRequest)

Confirms that the shareRequest param contains either usernames or e-mails and also validates that the user performing this operation has the permission to view other users in this JIRA instance.

Parameters
remoteUser The user performing the share operation
shareBean Bean containing information about who to share with
searchRequest A saved filter being shared or null if a unsaved JQL search is being shared
Returns
  • A service result