@PublicApi public interface BulkEditBean extends OperationContext, SingleIssueModeEditBean
Modifier and Type | Field and Description |
---|---|
static String |
BULK_DELETE |
static String |
BULK_DELETE_OP |
static String |
BULK_EDIT_OP |
static String |
BULK_MOVE_OP |
static String |
BULKEDIT_PREFIX |
static String |
SUBTASK_STATUS_INFO |
Modifier and Type | Method and Description |
---|---|
void |
addAvailablePreviousStep(int stepId) |
void |
addIssues(Collection<Issue> issues) |
void |
addRetainValue(String fieldId) |
void |
addTransitionErrors(String issueKey,
Collection<String> errors) |
void |
clearAvailablePreviousSteps() |
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.
|
BulkEditMultiSelectFieldBean |
getBulkEditMultiSelectFieldBean()
Returns
BulkEditMultiSelectFieldBean which stores change mode options
for multi select system fields (Affects Version/s, Fix Version/s, Labels, Components) |
String |
getCheckboxName(Issue issue) |
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.
|
CustomField |
getCustomField(String customFieldKey) |
String |
getCustomFieldView(CustomField customField) |
Collection<FieldLayout> |
getFieldLayouts()
Returns all the unique field layouts of the selected issues
|
FieldScreenRenderer |
getFieldScreenRenderer() |
Map<String,Map<Long,Long>> |
getFieldSubstitutionMap() |
Map<String,Object> |
getFieldValues() |
Map<String,Object> |
getFieldValuesHolder() |
Issue |
getFirstTargetIssueObject()
This method is used to get a target issue that will provide the correct context (i.e.
|
Set<Issue> |
getInvalidIssues()
Gets issues whose status is null
|
Collection<org.ofbiz.core.entity.GenericValue> |
getInvalidStatuses()
Gets a set of invalid statuses that are not valid in the destination workflow
|
int |
getInvalidSubTaskCount() |
Set<String> |
getInvalidSubTaskStatusesByType(String subTaskTypeId) |
Set<String> |
getInvalidSubTaskTypes() |
IssueOperation |
getIssueOperation() |
List<Issue> |
getIssuesFromSearchRequest() |
Collection<?> |
getIssuesInUse() |
IssueType |
getIssueType() |
Collection<IssueType> |
getIssueTypeObjects() |
Collection<String> |
getIssueTypes() |
String |
getKey()
Returns a string that represents a "unique" identifier for this bulke edit bean
|
int |
getMaxIssues()
If there is a limit on the number of issues that can be bulk edited, this will return that number,
otherwise -1.
|
Map<?,?> |
getMessagedFieldLayoutItems() |
Collection<?> |
getMoveFieldLayoutItems() |
String |
getOperationName() |
Map<String,?> |
getParams() |
BulkEditBean |
getParentBulkEditBean() |
Collection<Long> |
getParentIssueIds() |
String |
getParentIssueKey()
Gets the destination parent issue for issue->subtask conversion.
|
Collection<String> |
getParentIssueKeys() |
Issue |
getParentIssueObject()
returns object from database, the object is queried by
getParentIssueKey() . |
Project |
getProject()
Deprecated.
Use
getSingleProject() instead. Since v5.2. |
Collection<Long> |
getProjectIds()
returns a list of project ids for projects which the currently selected issues belong to.
|
Collection<Project> |
getProjectObjects() |
Collection<org.ofbiz.core.entity.GenericValue> |
getProjects()
Deprecated.
Use
getProjectObjects() instead. Since v5.2. |
String |
getRedirectUrl()
Returns the redirect URL.
|
MultiBulkMoveBean |
getRelatedMultiBulkMoveBean() |
Collection<?> |
getRemovedFields() |
Set<String> |
getRetainValues() |
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.
|
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.
|
String |
getSelectedTransitionName() |
WorkflowTransitionKey |
getSelectedWFTransitionKey() |
Project |
getSingleProject()
Returns the single Project if there is only one Project in this BulkEditBean, otherwise throws an IllegalStateException.
|
Map<String,String> |
getStatusMapHolder() |
BulkEditBean |
getSubTaskBulkEditBean() |
List<Issue> |
getSubTaskOfSelectedIssues()
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.
|
Collection<String> |
getSubTaskStatusHolder() |
FieldLayout |
getTargetFieldLayout() |
FieldLayout |
getTargetFieldLayoutForType(String targetTypeId) |
List<org.ofbiz.core.entity.GenericValue> |
getTargetIssueGVs()
This is a convinience method for converting the list of objects to a list of GenericValues
|
Map<Issue,Issue> |
getTargetIssueObjects() |
IssueType |
getTargetIssueType() |
String |
getTargetIssueTypeId() |
IssueType |
getTargetIssueTypeObject() |
Long |
getTargetPid() |
Project |
getTargetProject() |
Status |
getTargetStatus(Issue issue) |
Status |
getTargetStatusObject(Issue issue)
Deprecated.
Use
getTargetStatusObject(com.atlassian.jira.issue.Issue) instead. Since v7.0 |
JiraWorkflow |
getTargetWorkflow() |
JiraWorkflow |
getTargetWorkflowByType(String issueTypeId) |
Map<String,Collection<String>> |
getTransitionErrors(Integer maxCount)
Get the transition errors after bulk issue transition
|
List<WorkflowTransitionKey> |
getTransitionIdsForWorkflow(String workflowName) |
List<String> |
getTransitionIssueKeys(WorkflowTransitionKey workflowTransitionKey) |
String |
getTransitionName(String workflowName,
String actionDescriptorId) |
Set<String> |
getWorkflowsInUse() |
org.apache.commons.collections.MultiMap |
getWorkflowTransitionMap() |
void |
initMultiBulkBean() |
void |
initMultiBulkBeanWithSubTasks() |
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.
|
boolean |
isAvailablePreviousStep(int stepId) |
boolean |
isChecked(Issue issue) |
boolean |
isHasMailServer()
Check if a mail server has been specified.
|
boolean |
isMultipleProjects() |
boolean |
isMutipleIssueTypes() |
boolean |
isOnlyContainsSubTasks() |
boolean |
isRedirectUrlSet()
Whether the URL to return to has been set yet.
|
boolean |
isRetainChecked(String fieldId) |
boolean |
isSendBulkNotification() |
boolean |
isServiceDeskProjectIssuesPresent()
Since 8.1.
|
boolean |
isSoftwareProjectIssuesPresent()
Since 8.1.
|
boolean |
isSubTaskCollection() |
boolean |
isSubTaskOnly() |
boolean |
isTranisitionErrorsLimited(Integer maxCount) |
boolean |
isTransitionChecked(WorkflowTransitionKey workflowTransitionKey) |
void |
populateStatusHolder() |
void |
populateSubTaskStatusHolder() |
void |
resetMoveData() |
void |
resetWorkflowTransitionSelection() |
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.
|
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.
|
void |
setFieldScreenRenderer(FieldScreenRenderer fieldScreenRenderer) |
void |
setInvalidSubTaskStatusesByType(Map<String,Set<String>> invalidSubTaskStatusesByType) |
void |
setInvalidSubTaskTypes(Set<String> invalidSubTaskTypes) |
void |
setIssuesFromSearchRequest(List<Issue> issuesFromSearchRequest) |
void |
setIssuesInUse(Collection<?> issuesInUse) |
void |
setMaxIssues(int maxIssues)
Sets the maximum number of issues allowed to be bulk edited at once.
|
void |
setMessagedFieldLayoutItems(Map<?,?> messagedFieldLayoutItems) |
void |
setMoveFieldLayoutItems(Collection<?> moveFieldLayoutItems) |
void |
setOperationName(String operationName) |
void |
setParams(Map<String,?> params) |
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.
|
void |
setParentIssueKey(String parentIssueKey)
Sets the destination parent issue for issue->subtask conversion.
|
void |
setRedirectUrl(String redirectUrl)
Sets the URL to which user should be redirected once the bulk operation is finished.
|
void |
setRelatedMultiBulkMoveBean(MultiBulkMoveBean relatedMultiBulkMoveBean) |
void |
setRemovedFields(Set<?> removedFields) |
void |
setRetainValues(Set<String> retainValues) |
void |
setSelectedWFTransitionKey(WorkflowTransitionKey workflowTransitionKey) |
void |
setSendBulkNotification(boolean sendBulkNotification) |
void |
setSubTaskBulkEditBean(BulkEditBean subTaskBulkEditBean) |
void |
setSubTaskOfSelectedIssues(List<Issue> subTaskOfSelectedIssues)
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.
|
void |
setTargetFieldLayout()
Sets the targetFieldLayout to the appropriate FieldLayout (aka "Field Configuration"); for the target Project and
Issue Type.
|
void |
setTargetIssueObjects(Map<Issue,Issue> targetIssueObjects) |
void |
setTargetIssueTypeId(String id) |
void |
setTargetProject(org.ofbiz.core.entity.GenericValue project)
Deprecated.
Use
setTargetProject(com.atlassian.jira.project.Project) instead. Since v5.2. |
void |
setTargetProject(Project project) |
void |
setWorkflowTransitionMap(org.apache.commons.collections.MultiMap workflowTransitionMap) |
getSingleIssueKey, isSingleMode, setSingleIssueKey
static final String SUBTASK_STATUS_INFO
static final String BULK_MOVE_OP
static final String BULK_DELETE_OP
static final String BULK_EDIT_OP
static final String BULK_DELETE
static final String BULKEDIT_PREFIX
BulkEditBean getParentBulkEditBean()
@Deprecated void initSelectedIssues(Collection<Issue> selectedIssues)
BulkEditBean
with the selected issuesselectedIssues
- Required selected Issues.void addIssues(Collection<Issue> issues)
@Deprecated List<Issue> getSelectedIssues()
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.
@Deprecated List<Issue> getSelectedIssuesIncludingSubTasks()
boolean isChecked(Issue issue)
boolean isMultipleProjects()
boolean isMutipleIssueTypes()
Project getProject()
getSingleProject()
instead. Since v5.2.Project getSingleProject()
isMultipleProjects()
IssueType getIssueType()
Collection<FieldLayout> getFieldLayouts()
String getKey()
Collection<Long> getProjectIds()
@Deprecated Collection<org.ofbiz.core.entity.GenericValue> getProjects()
getProjectObjects()
instead. Since v5.2.Collection<Project> getProjectObjects()
Collection<String> getIssueTypes()
Collection<IssueType> getIssueTypeObjects()
Collection<String> getParentIssueKeys()
Collection<Long> getParentIssueIds()
CustomField getCustomField(String customFieldKey) throws org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericEntityException
String getCustomFieldView(CustomField customField) throws FieldValidationException
FieldValidationException
void setIssuesInUse(Collection<?> issuesInUse)
void addAvailablePreviousStep(int stepId)
void clearAvailablePreviousSteps()
boolean isAvailablePreviousStep(int stepId)
boolean isHasMailServer()
Collection<?> getMoveFieldLayoutItems()
void setMoveFieldLayoutItems(Collection<?> moveFieldLayoutItems)
Long getTargetPid()
void setTargetProject(org.ofbiz.core.entity.GenericValue project)
setTargetProject(com.atlassian.jira.project.Project)
instead. Since v5.2.void setTargetProject(Project project)
Project getTargetProject()
void setTargetIssueTypeId(String id)
String getTargetIssueTypeId()
IssueType getTargetIssueType()
IssueType getTargetIssueTypeObject()
void populateStatusHolder() throws WorkflowException
WorkflowException
Collection<org.ofbiz.core.entity.GenericValue> getInvalidStatuses() throws WorkflowException
GenericValue
objectsWorkflowException
Set<Issue> getInvalidIssues() throws WorkflowException
Issue
objects. Emoty Set if no invalid issuesWorkflowException
Set<String> getInvalidSubTaskTypes() throws WorkflowException
WorkflowException
Set<String> getInvalidSubTaskStatusesByType(String subTaskTypeId) throws WorkflowException
WorkflowException
void setTargetFieldLayout()
FieldLayout getTargetFieldLayout()
FieldLayout getTargetFieldLayoutForType(String targetTypeId)
JiraWorkflow getTargetWorkflow() throws WorkflowException
WorkflowException
Issue getFirstTargetIssueObject()
List<org.ofbiz.core.entity.GenericValue> getTargetIssueGVs()
@Deprecated Status getTargetStatusObject(Issue issue)
getTargetStatusObject(com.atlassian.jira.issue.Issue)
instead. Since v7.0Collection<?> getRemovedFields()
void setRemovedFields(Set<?> removedFields)
void resetMoveData()
void populateSubTaskStatusHolder() throws WorkflowException
WorkflowException
JiraWorkflow getTargetWorkflowByType(String issueTypeId) throws WorkflowException
WorkflowException
Collection<String> getSubTaskStatusHolder()
boolean isRetainChecked(String fieldId)
boolean isSubTaskCollection()
boolean isSubTaskOnly()
String getOperationName()
void setOperationName(String operationName)
void setInvalidSubTaskStatusesByType(Map<String,Set<String>> invalidSubTaskStatusesByType)
int getInvalidSubTaskCount()
void addRetainValue(String fieldId)
@ExperimentalApi boolean isServiceDeskProjectIssuesPresent()
@ExperimentalApi boolean isSoftwareProjectIssuesPresent()
@Deprecated List<Issue> getSubTaskOfSelectedIssues()
@Deprecated void setSubTaskOfSelectedIssues(List<Issue> subTaskOfSelectedIssues)
@Deprecated int getCurrentStep()
@Deprecated void setCurrentStep(int currentStep)
@Deprecated Map<String,BulkEditAction> getActions()
@Deprecated void setActions(Map<String,BulkEditAction> actions)
Map<String,Object> getFieldValuesHolder()
getFieldValuesHolder
in interface OperationContext
IssueOperation getIssueOperation()
getIssueOperation
in interface OperationContext
Collection<?> getIssuesInUse()
BulkEditBean getSubTaskBulkEditBean()
void setSubTaskBulkEditBean(BulkEditBean subTaskBulkEditBean)
MultiBulkMoveBean getRelatedMultiBulkMoveBean()
void setRelatedMultiBulkMoveBean(MultiBulkMoveBean relatedMultiBulkMoveBean)
boolean isSendBulkNotification()
void setSendBulkNotification(boolean sendBulkNotification)
org.apache.commons.collections.MultiMap getWorkflowTransitionMap()
void setWorkflowTransitionMap(org.apache.commons.collections.MultiMap workflowTransitionMap)
List<WorkflowTransitionKey> getTransitionIdsForWorkflow(String workflowName)
List<String> getTransitionIssueKeys(WorkflowTransitionKey workflowTransitionKey)
void setSelectedWFTransitionKey(WorkflowTransitionKey workflowTransitionKey)
WorkflowTransitionKey getSelectedWFTransitionKey()
void resetWorkflowTransitionSelection()
boolean isTransitionChecked(WorkflowTransitionKey workflowTransitionKey)
String getSelectedTransitionName()
void setFieldScreenRenderer(FieldScreenRenderer fieldScreenRenderer)
FieldScreenRenderer getFieldScreenRenderer()
Map<?,?> getMessagedFieldLayoutItems()
void setMessagedFieldLayoutItems(Map<?,?> messagedFieldLayoutItems)
void initMultiBulkBean()
void initMultiBulkBeanWithSubTasks()
boolean isOnlyContainsSubTasks()
Map<String,Collection<String>> getTransitionErrors(@Nullable Integer maxCount)
maxCount
- max count of errors to return or null
for no limits.void addTransitionErrors(@Nonnull String issueKey, @Nonnull Collection<String> errors)
boolean isTranisitionErrorsLimited(@Nullable Integer maxCount)
true
if there is more errors on transitioned issues than maxCount
.void setParentBulkEditBean(BulkEditBean parentBulkEditBean)
parentBulkEditBean
- The BulkEditBean that contains parent issues of the issues (subtasks); in this BulkEditBean.int getMaxIssues()
void setMaxIssues(int maxIssues)
maxIssues
- either -1 or a positive integer representing the maximum number of issues allowed for bulk edit.String getRedirectUrl()
setRedirectUrl(String)
.void setRedirectUrl(String redirectUrl)
boolean isRedirectUrlSet()
setRedirectUrl(String)
has been called before.@ExperimentalApi BulkEditMultiSelectFieldBean getBulkEditMultiSelectFieldBean()
BulkEditMultiSelectFieldBean
which stores change mode options
for multi select system fields (Affects Version/s, Fix Version/s, Labels, Components)BulkEditMultiSelectFieldBean
for bulk edit operation@ExperimentalApi @Nullable String getParentIssueKey()
@ExperimentalApi void setParentIssueKey(@Nullable String parentIssueKey)
parentIssueKey
- Parent issue key@ExperimentalApi @Nullable Issue getParentIssueObject()
getParentIssueKey()
.Issue
obtained from database, queried by getParentIssueKey()
.Copyright © 2002-2021 Atlassian. All Rights Reserved.