Package com.atlassian.jira.web.bean

Interface BulkEditBean

All Superinterfaces:
OperationContext, SingleIssueModeEditBean
All Known Implementing Classes:
BulkEditBeanImpl
@PublicApi public interface BulkEditBean extends OperationContext, SingleIssueModeEditBean
Used in the BulkEdit Wizard Stores in session: currentStep action selected and values associated with that action issues selected

  • Field Details

  • Method Details

    • getParentBulkEditBean

      BulkEditBean getParentBulkEditBean()

    • initSelectedIssues

      @Deprecated void initSelectedIssues(Collection<Issue> selectedIssues)
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
      Initialises the BulkEditBean with the selected issues
      Parameters:
      selectedIssues - Required selected Issues.

    • addIssues

      void addIssues(Collection<Issue> issues)

    • getSelectedIssues

      @Deprecated List<Issue> getSelectedIssues()
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
      Returns a list of "selected" issues. For the "top level" BulkEditBean this should be the actual issues chosen by the user for the bulk operation.

      The Bulk Move operation will then break this list up in groups of project and issue type and store each of these types in its own BulkEditBean, so for these nested BulkEditBeans this list may be a subset of the original selected issues. Furthermore when moving parent issues to a new Project, we will have to move any subtasks as well. In this case a third level of BulkEditBean is created and these ones will have subtasks that may not have been explicitly selected by the user at all.

      Returns:
      List of the Selected Issues

    • getSelectedIssuesIncludingSubTasks

      @Deprecated List<Issue> getSelectedIssuesIncludingSubTasks()
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

    • isChecked

      boolean isChecked(Issue issue)

    • isMultipleProjects

      boolean isMultipleProjects()

    • isMutipleIssueTypes

      boolean isMutipleIssueTypes()

    • getProject

      Project getProject()
      Deprecated.
      Use getSingleProject() instead. Since v5.2.

    • getSingleProject

      Project getSingleProject()
      Returns the single Project if there is only one Project in this BulkEditBean, otherwise throws an IllegalStateException.
      Returns:
      the single Project if there is only one Project in this BulkEditBean, otherwise throws an IllegalStateException.
      See Also:

    • getIssueType

      IssueType getIssueType()

    • getFieldLayouts

      Collection<FieldLayout> getFieldLayouts()
      Returns all the unique field layouts of the selected issues
      Returns:
      Collection of the FieldLayouts.

    • getKey

      String getKey()
      Returns a string that represents a "unique" identifier for this bulke edit bean
      Returns:
      unique key formed from projects, issue types, target project if a subtask only bulkeditbean and size of the bean

    • getProjectIds

      Collection<Long> getProjectIds()
      returns a list of project ids for projects which the currently selected issues belong to.
      Returns:
      A list of project ids for projects which the currently selected issues belong to.

    • getProjects

      @Deprecated Collection<org.ofbiz.core.entity.GenericValue> getProjects()
      Deprecated.
      Use getProjectObjects() instead. Since v5.2.
      Returns:

    • getProjectObjects

      Collection<Project> getProjectObjects()

    • getIssueTypes

      Collection<String> getIssueTypes()

    • getIssueTypeObjects

      Collection<IssueType> getIssueTypeObjects()

    • getParentIssueKeys

      Collection<String> getParentIssueKeys()

    • getParentIssueIds

      Collection<Long> getParentIssueIds()

    • getCheckboxName

      String getCheckboxName(Issue issue)

    • getCustomField

      CustomField getCustomField(String customFieldKey) throws org.ofbiz.core.entity.GenericEntityException
      Throws:
      org.ofbiz.core.entity.GenericEntityException

    • getCustomFieldView

      String getCustomFieldView(CustomField customField) throws FieldValidationException
      Throws:
      FieldValidationException

    • setParams

      void setParams(Map<String,?> params)

    • getParams

      Map<String,?> getParams()

    • setIssuesInUse

      void setIssuesInUse(Collection<?> issuesInUse)

    • addAvailablePreviousStep

      void addAvailablePreviousStep(int stepId)

    • clearAvailablePreviousSteps

      void clearAvailablePreviousSteps()

    • isAvailablePreviousStep

      boolean isAvailablePreviousStep(int stepId)

    • isHasMailServer

      boolean isHasMailServer()
      Check if a mail server has been specified.
      Returns:
      boolean true if a mail server has been specified

    • getMoveFieldLayoutItems

      Collection<?> getMoveFieldLayoutItems()

    • setMoveFieldLayoutItems

      void setMoveFieldLayoutItems(Collection<?> moveFieldLayoutItems)

    • getTargetPid

      Long getTargetPid()

    • setTargetProject

      void setTargetProject(org.ofbiz.core.entity.GenericValue project)
      Deprecated.
      Use setTargetProject(com.atlassian.jira.project.Project) instead. Since v5.2.

    • setTargetProject

      void setTargetProject(Project project)

    • getTargetProject

      Project getTargetProject()

    • setTargetIssueTypeId

      void setTargetIssueTypeId(String id)

    • getTargetIssueTypeId

      String getTargetIssueTypeId()

    • getTargetIssueType

      IssueType getTargetIssueType()

    • getTargetIssueTypeObject

      IssueType getTargetIssueTypeObject()

    • populateStatusHolder

      void populateStatusHolder() throws WorkflowException
      Throws:
      WorkflowException

    • getInvalidStatuses

      Collection<org.ofbiz.core.entity.GenericValue> getInvalidStatuses() throws WorkflowException
      Gets a set of invalid statuses that are not valid in the destination workflow
      Returns:
      Set of GenericValue objects
      Throws:
      WorkflowException

    • getInvalidIssues

      Set<Issue> getInvalidIssues() throws WorkflowException
      Gets issues whose status is null
      Returns:
      Set of Issue objects. Emoty Set if no invalid issues
      Throws:
      WorkflowException

    • getInvalidSubTaskTypes

      Set<String> getInvalidSubTaskTypes() throws WorkflowException
      Throws:
      WorkflowException

    • getInvalidSubTaskStatusesByType

      Set<String> getInvalidSubTaskStatusesByType(String subTaskTypeId) throws WorkflowException
      Throws:
      WorkflowException

    • setTargetFieldLayout

      void setTargetFieldLayout()
      Sets the targetFieldLayout to the appropriate FieldLayout (aka "Field Configuration"); for the target Project and Issue Type.

    • getTargetFieldLayout

      FieldLayout getTargetFieldLayout()

    • getTargetFieldLayoutForType

      FieldLayout getTargetFieldLayoutForType(String targetTypeId)

    • getTargetWorkflow

      JiraWorkflow getTargetWorkflow() throws WorkflowException
      Throws:
      WorkflowException

    • getFirstTargetIssueObject

      Issue getFirstTargetIssueObject()
      This method is used to get a target issue that will provide the correct context (i.e. project and issue type);, for where you are moving to. The object returned is not mapped to a specific selected issue.
      Returns:
      an issue whose project and issue type are of where the you are moving to.

    • getTargetIssueObjects

      Map<Issue,Issue> getTargetIssueObjects()

    • setTargetIssueObjects

      void setTargetIssueObjects(Map<Issue,Issue> targetIssueObjects)

    • getTargetIssueGVs

      List<org.ofbiz.core.entity.GenericValue> getTargetIssueGVs()
      This is a convinience method for converting the list of objects to a list of GenericValues
      Returns:
      list of GenericValue issue objects

    • getTargetStatusObject

      @Deprecated Status getTargetStatusObject(Issue issue)
      Deprecated.
      Use getTargetStatusObject(com.atlassian.jira.issue.Issue) instead. Since v7.0

    • getTargetStatus

      Status getTargetStatus(Issue issue)

    • getStatusMapHolder

      Map<String,String> getStatusMapHolder()

    • getRemovedFields

      Collection<?> getRemovedFields()

    • setRemovedFields

      void setRemovedFields(Set<?> removedFields)

    • resetMoveData

      void resetMoveData()

    • populateSubTaskStatusHolder

      void populateSubTaskStatusHolder() throws WorkflowException
      Throws:
      WorkflowException

    • getTargetWorkflowByType

      JiraWorkflow getTargetWorkflowByType(String issueTypeId) throws WorkflowException
      Throws:
      WorkflowException

    • getSubTaskStatusHolder

      Collection<String> getSubTaskStatusHolder()

    • isRetainChecked

      boolean isRetainChecked(String fieldId)

    • isSubTaskCollection

      boolean isSubTaskCollection()

    • isSubTaskOnly

      boolean isSubTaskOnly()

    • getOperationName

      String getOperationName()

    • setOperationName

      void setOperationName(String operationName)

    • setInvalidSubTaskStatusesByType

      void setInvalidSubTaskStatusesByType(Map<String,Set<String>> invalidSubTaskStatusesByType)

    • setInvalidSubTaskTypes

      void setInvalidSubTaskTypes(Set<String> invalidSubTaskTypes)

    • getInvalidSubTaskCount

      int getInvalidSubTaskCount()

    • getRetainValues

      Set<String> getRetainValues()

    • setRetainValues

      void setRetainValues(Set<String> retainValues)

    • addRetainValue

      void addRetainValue(String fieldId)

    • isServiceDeskProjectIssuesPresent

      @ExperimentalApi boolean isServiceDeskProjectIssuesPresent()
      Since 8.1. Returns true if any of selected issues belong to ServiceDesk project types

    • isSoftwareProjectIssuesPresent

      @ExperimentalApi boolean isSoftwareProjectIssuesPresent()
      Since 8.1. Returns true if any of selected issues belong to Software project types

    • getSubTaskOfSelectedIssues

      @Deprecated List<Issue> getSubTaskOfSelectedIssues()
      Deprecated.
      Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage.

    • setSubTaskOfSelectedIssues

      @Deprecated void setSubTaskOfSelectedIssues(List<Issue> subTaskOfSelectedIssues)
      Deprecated.
      Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage.

    • getIssuesToSubtasks

      Map<Long,List<Issue>> getIssuesToSubtasks()

    • setIssuesToSubtasks

      void setIssuesToSubtasks(Map<Long,List<Issue>> issuesToSubtasks)

    • getIssuesFromSearchRequest

      List<Issue> getIssuesFromSearchRequest()

    • setIssuesFromSearchRequest

      void setIssuesFromSearchRequest(List<Issue> issuesFromSearchRequest)

    • getCurrentStep

      @Deprecated int getCurrentStep()
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

    • setCurrentStep

      @Deprecated void setCurrentStep(int currentStep)
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

    • getActions

      @Deprecated Map<String,BulkEditAction> getActions()
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

    • setActions

      @Deprecated void setActions(Map<String,BulkEditAction> actions)
      Deprecated.
      Since 7.1. Storing this on the httpsession does not work for cloud. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

    • getFieldValues

      Map<String,Object> getFieldValues()

    • getFieldValuesHolder

      Map<String,Object> getFieldValuesHolder()
      Specified by:
      getFieldValuesHolder in interface OperationContext

    • getIssueOperation

      IssueOperation getIssueOperation()
      Specified by:
      getIssueOperation in interface OperationContext

    • getIssuesInUse

      Collection<?> getIssuesInUse()

    • getSubTaskBulkEditBean

      BulkEditBean getSubTaskBulkEditBean()

    • setSubTaskBulkEditBean

      void setSubTaskBulkEditBean(BulkEditBean subTaskBulkEditBean)

    • getRelatedMultiBulkMoveBean

      MultiBulkMoveBean getRelatedMultiBulkMoveBean()

    • setRelatedMultiBulkMoveBean

      void setRelatedMultiBulkMoveBean(MultiBulkMoveBean relatedMultiBulkMoveBean)

    • isSendBulkNotification

      boolean isSendBulkNotification()

    • setSendBulkNotification

      void setSendBulkNotification(boolean sendBulkNotification)

    • getWorkflowTransitionMap

      org.apache.commons.collections.MultiMap getWorkflowTransitionMap()

    • setWorkflowTransitionMap

      void setWorkflowTransitionMap(org.apache.commons.collections.MultiMap workflowTransitionMap)

    • getWorkflowsInUse

      Set<String> getWorkflowsInUse()

    • getTransitionIdsForWorkflow

      List<WorkflowTransitionKey> getTransitionIdsForWorkflow(String workflowName)

    • getTransitionName

      String getTransitionName(String workflowName, String actionDescriptorId)

    • getTransitionIssueKeys

      List<String> getTransitionIssueKeys(WorkflowTransitionKey workflowTransitionKey)

    • setSelectedWFTransitionKey

      void setSelectedWFTransitionKey(WorkflowTransitionKey workflowTransitionKey)

    • getSelectedWFTransitionKey

      WorkflowTransitionKey getSelectedWFTransitionKey()

    • resetWorkflowTransitionSelection

      void resetWorkflowTransitionSelection()

    • isTransitionChecked

      boolean isTransitionChecked(WorkflowTransitionKey workflowTransitionKey)

    • getSelectedTransitionName

      String getSelectedTransitionName()

    • setFieldScreenRenderer

      void setFieldScreenRenderer(FieldScreenRenderer fieldScreenRenderer)

    • getFieldScreenRenderer

      FieldScreenRenderer getFieldScreenRenderer()

    • getMessagedFieldLayoutItems

      Map<?,?> getMessagedFieldLayoutItems()

    • setMessagedFieldLayoutItems

      void setMessagedFieldLayoutItems(Map<?,?> messagedFieldLayoutItems)

    • initMultiBulkBean

      void initMultiBulkBean()

    • initMultiBulkBeanWithSubTasks

      void initMultiBulkBeanWithSubTasks()

    • isOnlyContainsSubTasks

      boolean isOnlyContainsSubTasks()

    • getTransitionErrors

      Map<String,Collection<String>> getTransitionErrors(@Nullable Integer maxCount)
      Get the transition errors after bulk issue transition
      Parameters:
      maxCount - max count of errors to return or null for no limits.
      Returns:
      transition errors after bulk issue transition

    • addTransitionErrors

      void addTransitionErrors(@Nonnull String issueKey, @Nonnull Collection<String> errors)

    • isTranisitionErrorsLimited

      boolean isTranisitionErrorsLimited(@Nullable Integer maxCount)
      Returns:
      true if there is more errors on transitioned issues than maxCount.

    • setParentBulkEditBean

      void setParentBulkEditBean(BulkEditBean parentBulkEditBean)
      If this BulkEditBean contains subtasks of another BulkEditBean, then we can set a pointer back to the BulkEditBean containing the parent issues. This is used so that the subtask issues have access to the new values in their parent issues. See JRA-13937 where we had to ensure that the subtasks in a Bulk Move could get to the new Security Level of their parents.
      Parameters:
      parentBulkEditBean - The BulkEditBean that contains parent issues of the issues (subtasks); in this BulkEditBean.

    • getMaxIssues

      int getMaxIssues()
      If there is a limit on the number of issues that can be bulk edited, this will return that number, otherwise -1.
      Returns:
      -1 to indicate no limit on bulk editing issues, otherwise the number of the limit.

    • setMaxIssues

      void setMaxIssues(int maxIssues)
      Sets the maximum number of issues allowed to be bulk edited at once. Use -1 to indicate no limit.
      Parameters:
      maxIssues - either -1 or a positive integer representing the maximum number of issues allowed for bulk edit.

    • getFieldSubstitutionMap

      Map<String,Map<Long,Long>> getFieldSubstitutionMap()

    • getRedirectUrl

      String getRedirectUrl()
      Returns the redirect URL. See setRedirectUrl(String).

    • setRedirectUrl

      void setRedirectUrl(String redirectUrl)
      Sets the URL to which user should be redirected once the bulk operation is finished. This is used only if a progress indicator is displayed to the user while the operation is being executed.

    • isRedirectUrlSet

      boolean isRedirectUrlSet()
      Whether the URL to return to has been set yet.
      Returns:
      true if setRedirectUrl(String) has been called before.

    • getBulkEditMultiSelectFieldBean

      @ExperimentalApi BulkEditMultiSelectFieldBean getBulkEditMultiSelectFieldBean()
      Returns BulkEditMultiSelectFieldBean which stores change mode options for system fields with multiple change modes configured.
      Returns:
      BulkEditMultiSelectFieldBean for bulk edit operation
      Since:
      v6.4

    • getParentIssueKey

      @ExperimentalApi @Nullable String getParentIssueKey()
      Gets the destination parent issue for issue->subtask conversion.
      Returns:
      Destination parent issue key
      Since:
      7.0

    • setParentIssueKey

      @ExperimentalApi void setParentIssueKey(@Nullable String parentIssueKey)
      Sets the destination parent issue for issue->subtask conversion.
      Parameters:
      parentIssueKey - Parent issue key
      Since:
      7.0

    • getParentIssueObject

      @ExperimentalApi @Nullable Issue getParentIssueObject()
      returns object from database, the object is queried by getParentIssueKey().
      Returns:
      Issue obtained from database, queried by getParentIssueKey().
      Since:
      7.0