public interface

BulkChangeWizard

com.atlassian.jira.functest.framework.navigation.BulkChangeWizard
Known Indirect Subclasses

Class Overview

Interface for working with the Bulk Change Wizard which is part of the Issue Navigator.

Promotes a "fluent-style" of usage by returning the stateful object as the result of each operation.

Summary

Nested Classes
interface BulkChangeWizard.BulkOperations  
class BulkChangeWizard.BulkOperationsCustom  
enum BulkChangeWizard.BulkOperationsImpl Various operations available in the bulk change wizard. 
enum BulkChangeWizard.InputTypes Types of inputs for the editing controls in a Bulk Change Wizard form  
enum BulkChangeWizard.WizardState States that the wizard can be in. 
Public Methods
BulkChangeWizard cancel()
Cancels the wizard.
BulkChangeWizard checkActionForField(String fieldName)
Check the "Action" checkbox for the chosen field.
BulkChangeWizard checkRetainForField(String fieldName)
Check the "Retain" checkbox for the chosen field.
BulkChangeWizard chooseOperation(BulkChangeWizard.BulkOperations operation)
Select the bulk operation to perform.
BulkChangeWizard chooseTargetContextForAll(String projectName, String issueType)
Chooses the target project and issue type for all issues to be moved to.
BulkChangeWizard chooseTargetContextForAll(String projectName)
Chooses the target project for all issues to be moved to.
BulkChangeWizard chooseTargetContextForEach(int numContextsToSelect, String projectName)
Chooses the target project to be moved to for each of the issue types to be moved.
BulkChangeWizard chooseWorkflowTransition(BulkChangeWizard.BulkOperations workflowTransition)
Select the workflow transition to perform.
BulkChangeWizard complete()
Completes the wizard and performs the bulk operation.
BulkChangeWizard finaliseFields()
Completes the entering of fields in this screen.
BulkChangeWizard.WizardState getState()
Returns the current state of the wizard.
BulkChangeWizard revertTo(BulkChangeWizard.WizardState state)
Reverts the wizard to any given previous stage.
BulkChangeWizard selectAllIssues()
Selects all issues from the last search to operate on.
BulkChangeWizard setFieldValue(BulkChangeWizard.InputTypes inputType, String fieldName, String value)
Set a value for a field.
BulkChangeWizard setFieldValue(String fieldName, String value)
Set a value for a field.
BulkChangeWizard waitForBulkChangeCompletion()
Waits until the bulk changes are completed.

Public Methods

public BulkChangeWizard cancel ()

Cancels the wizard. Simulates clicking on the cancel link.

Wizard must be in any state except COMPLETE.

Once performed the wizard will set itself to state COMPLETE.

Returns
  • the wizard.
See Also

public BulkChangeWizard checkActionForField (String fieldName)

Check the "Action" checkbox for the chosen field.

Wizard must be in EDIT, SET_FIELDS to perform this operation.

Note: wizard does not advance after this operation; multiple calls to this method can be made. Once finished, call finaliseFields().

Parameters
fieldName the name of the field
Returns
  • the wizard

public BulkChangeWizard checkRetainForField (String fieldName)

Check the "Retain" checkbox for the chosen field.

Wizard must be in MOVE, SET_FIELDS to perform this operation.

Note: wizard does not advance after this operation; multiple calls to this method can be made. Once finished, call finaliseFields().

Parameters
fieldName the name of the field
Returns
  • the wizard

public BulkChangeWizard chooseOperation (BulkChangeWizard.BulkOperations operation)

Select the bulk operation to perform.

Wizard must be in CHOOSE_OPERATION to perform this operation.

Once selected, the wizard will advance to CHOOSE_TARGET_CONTEXTS.

Parameters
operation the operation to perform
Returns
  • the wizard

public BulkChangeWizard chooseTargetContextForAll (String projectName, String issueType)

Chooses the target project and issue type for all issues to be moved to. The target issue type will remain as the default selected item. This target context will apply to all issues being moved.

WARN: note that this only currently works when you are moving issues from Homosapien project, and when that is the only source project context offered on the page.

Wizard must be in MOVE, CHOOSE_TARGET_CONTEXTS to perform this operation.

Once selected, the wizard will advance to SET_FIELDS.

Parameters
projectName the name of the project to use in the target context e.g. monkey
Returns
  • the wizard

public BulkChangeWizard chooseTargetContextForAll (String projectName)

Chooses the target project for all issues to be moved to. The target issue type will remain as the default selected item. This target context will apply to all issues being moved.

WARN: note that this only currently works when you are moving issues from Homosapien project, and when that is the only source project context offered on the page.

Wizard must be in MOVE, CHOOSE_TARGET_CONTEXTS to perform this operation.

Once selected, the wizard will advance to SET_FIELDS.

Parameters
projectName the name of the project to use in the target context e.g. monkey
Returns
  • the wizard

public BulkChangeWizard chooseTargetContextForEach (int numContextsToSelect, String projectName)

Chooses the target project to be moved to for each of the issue types to be moved. This target context will apply to all issues being moved, preserving issue types mapping.

WARN: note that this only currently works when you are moving issues from Homosapien project, and when that is the only source project context offered on the page.

Wizard must be in MOVE, CHOOSE_TARGET_CONTEXTS to perform this operation.

Once selected, the wizard will advance to SET_FIELDS.

Parameters
numContextsToSelect the expected number of contexts to be set.
projectName the name of the project to use in the target context e.g. monkey
Returns
  • the wizard

public BulkChangeWizard chooseWorkflowTransition (BulkChangeWizard.BulkOperations workflowTransition)

Select the workflow transition to perform.

Wizard must be in CHOOSE_OPERATION to perform this operation.

Once selected, the wizard will advance

public BulkChangeWizard complete ()

Completes the wizard and performs the bulk operation.

Wizard must be in CONFIRMATION to perform this operation.

Once performed, the wizard will advance to COMPLETE. There is no further state to advance to after this. This wizard instance should not be used again.

Returns
  • the wizard

public BulkChangeWizard finaliseFields ()

Completes the entering of fields in this screen.

Wizard must be in SET_FIELDS to perform this operation.

If there are more field screens to complete, the wizard will remain in SET_FIELDS. Otherwise, it will advance to CONFIRMATION.

Returns
  • the wizard

public BulkChangeWizard.WizardState getState ()

Returns the current state of the wizard.

Returns
  • the state of the wizard.

public BulkChangeWizard revertTo (BulkChangeWizard.WizardState state)

Reverts the wizard to any given previous stage.

Wizard must be in any state that is further than the requested state.

Once performed, wizard will revert to the desired state.

Returns
  • the wizard.

public BulkChangeWizard selectAllIssues ()

Selects all issues from the last search to operate on.

Wizard must be in SELECT_ISSUES to perform this operation.

Once selected, the wizard will advance to CHOOSE_OPERATION.

Returns
  • the wizard

public BulkChangeWizard setFieldValue (BulkChangeWizard.InputTypes inputType, String fieldName, String value)

Set a value for a field.

Wizard must be in SET_FIELDS to perform this operation.

Note: wizard does not advance after this operation; multiple calls to this method can be made. Once finished, call finaliseFields().

Parameters
inputType the type of control you are using to set the field value
fieldName the name of the field to set e.g. components, timetracking_originalestimate
value the value to set e.g. 10000, 5h
Returns
  • the wizard
See Also

public BulkChangeWizard setFieldValue (String fieldName, String value)

Set a value for a field. It is assumed that the field is settable via text input.

Wizard must be in SET_FIELDS to perform this operation.

Note: wizard does not advance after this operation; multiple calls to this method can be made. Once finished, call finaliseFields().

Parameters
fieldName the name of the field to set e.g. components, timetracking_originalestimate
value the value to set e.g. 10000, 5h
Returns
  • the wizard

public BulkChangeWizard waitForBulkChangeCompletion ()

Waits until the bulk changes are completed.

Wizard must be in COMPLETE state to perform this operation.

This operation doesn't change the wizard state.

Returns
  • the wizard