com.atlassian.jira.functest.framework.navigation
Interface BulkChangeWizard

All Known Implementing Classes:

AbstractBulkChangeWizard, BulkChangeWizardImpl

public interface BulkChangeWizard

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.

Since:

v4.2

See Also:

IssueNavigatorNavigation.bulkChange(com.atlassian.jira.functest.framework.navigation.IssueNavigatorNavigation.BulkChangeOption)

Nested Class Summary

static class	BulkChangeWizard.BulkOperations Various operations available in the bulk change wizard.
static class	BulkChangeWizard.InputTypes Types of inputs for the editing controls in a Bulk Change Wizard form
static class	BulkChangeWizard.WizardState States that the wizard can be in.

Method Summary

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) Chooses the target project for all issues to be moved to.
BulkChangeWizard	complete() Completes the wizard and performs the bulk operation.
BulkChangeWizard	finaliseFields() Completes the entering of fields in this screen.
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.

Method Detail

selectAllIssues

BulkChangeWizard selectAllIssues()

Selects all issues from the last search to operate on.

Wizard must be in BulkChangeWizard.WizardState.SELECT_ISSUES to perform this operation.

Once selected, the wizard will advance to BulkChangeWizard.WizardState.CHOOSE_OPERATION.

Returns:

the wizard

chooseOperation

BulkChangeWizard chooseOperation(BulkChangeWizard.BulkOperations operation)

Select the bulk operation to perform.

Wizard must be in BulkChangeWizard.WizardState.CHOOSE_OPERATION to perform this operation.

Once selected, the wizard will advance to BulkChangeWizard.WizardState.CHOOSE_TARGET_CONTEXTS.

Parameters:

operation - the operation to perform

Returns:

the wizard

chooseTargetContextForAll

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.

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

Once selected, the wizard will advance to BulkChangeWizard.WizardState.SET_FIELDS.

Parameters:

projectName - the name of the project to use in the target context e.g. monkey

Returns:

the wizard

setFieldValue

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 BulkChangeWizard.WizardState.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

See Also:

finaliseFields(), setFieldValue(com.atlassian.jira.functest.framework.navigation.BulkChangeWizard.InputTypes, String, String)

setFieldValue

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

Set a value for a field.

Wizard must be in BulkChangeWizard.WizardState.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:

finaliseFields()

checkRetainForField

BulkChangeWizard checkRetainForField(String fieldName)

Check the "Retain" checkbox for the chosen field.

Wizard must be in BulkChangeWizard.BulkOperations.MOVE, BulkChangeWizard.WizardState.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

checkActionForField

BulkChangeWizard checkActionForField(String fieldName)

Check the "Action" checkbox for the chosen field.

Wizard must be in BulkChangeWizard.BulkOperations.EDIT, BulkChangeWizard.WizardState.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

finaliseFields

BulkChangeWizard finaliseFields()

Completes the entering of fields in this screen.

Wizard must be in BulkChangeWizard.WizardState.SET_FIELDS to perform this operation.

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

Returns:

the wizard

complete

BulkChangeWizard complete()

Completes the wizard and performs the bulk operation.

Wizard must be in BulkChangeWizard.WizardState.CONFIRMATION to perform this operation.

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

Returns:

the wizard