ProjectImportMapper (Atlassian JIRA

All Known Implementing Classes:

ProjectImportMapperImpl
```
@PublicApi
public interface ProjectImportMapper
```
The parent mapper that holds all sub-mappers that are used for a project import.

Since:

v3.13

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearMappedValues()` This will clear any mapped data that may have been entered into the mappers.
`SimpleProjectImportIdMapper`	`getChangeGroupMapper()` Gets a ProjectImportIdMapper that maps the change group id's from the old backup project data to the id's generated when adding the change group data to the new JIRA instance.
`SimpleProjectImportIdMapper`	`getCommentMapper()` Gets a ProjectImportIdMapper that maps the Comment id's from the old backup project data to the id's in the current system.
`SimpleProjectImportIdMapper`	`getComponentMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the project components "in-use" (required) by the backup projects data.
`CustomFieldMapper`	`getCustomFieldMapper()` Gets a CustomFieldMapper which, when fully populated, indicates all the custom fields "in-use" (required) by the backup projects data.
`CustomFieldOptionMapper`	`getCustomFieldOptionMapper()` Gets a CustomFieldOptionMapper which, when fully populated, indicates how to map the IDs of the Custom Field Options in the Import file, to the equivalent Option in the current JIRA.
`GroupMapper`	`getGroupMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the groups "in-use" (required) by the backup projects data.
`IssueLinkTypeMapper`	`getIssueLinkTypeMapper()` Gets a ProjectImportIdMapper that maps the IssueLinkType id's from the old backup project data to the id's in the current system.
`SimpleProjectImportIdMapper`	`getIssueMapper()` Gets a ProjectImportIdMapper that maps the issue id's from the old backup project data to the id's generated when adding the issue data to the new JIRA instance.
`SimpleProjectImportIdMapper`	`getIssueSecurityLevelMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue security levels "in-use" (required) by the backup projects data.
`IssueTypeMapper`	`getIssueTypeMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue issue types "in-use" (required) by the backup projects data.
`<T extends ProjectImportIdMapper> T`	`getNamedIdMapper(String name)` Get a mapper from the list of mappers.
`SimpleProjectImportIdMapper`	`getPriorityMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue priorities "in-use" (required) by the backup projects data.
`SimpleProjectImportIdMapper`	`getProjectMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the projects from the backup file and the mapped projects in the current JIRA instance.
`ProjectRoleActorMapper`	`getProjectRoleActorMapper()` Gets a ProjectRoleActorMapper which, when fully populated, indicates all the ProjectRoleActors "in-use" (optional) by the backup projects data's issues.
`SimpleProjectImportIdMapper`	`getProjectRoleMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the project roles "in-use" (required) by the backup projects data.
`SimpleProjectImportIdMapper`	`getResolutionMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue resolutions "in-use" (required) by the backup projects data.
`StatusMapper`	`getStatusMapper()` Gets a StatusMapper which, when fully populated, indicates all the issue statuses "in-use" (required) by the backup projects data.
`UserMapper`	`getUserMapper()` Gets a UserMapper which, when fully populated, indicates all the users "in-use" (required) by the backup projects data's issues.
`SimpleProjectImportIdMapper`	`getVersionMapper()` Gets a ProjectImportIdMapper which, when fully populated, indicates all the project versions "in-use" (required) by the backup projects data.
`ProjectImportIdMapper`	`putNamedIdMapper(String name, ProjectImportIdMapper mapper)` Add a mapper to the list of mappers.

- Method Detail
  - getProjectMapper
```
SimpleProjectImportIdMapper getProjectMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the projects from the backup file and the mapped projects in the current JIRA instance. The projects are mapped by project key.
    
    Returns:
    
    ProjectImportIdMapper containing project id mappings.
  - getUserMapper
```
UserMapper getUserMapper()
```
    Gets a UserMapper which, when fully populated, indicates all the users "in-use" (required) by the backup projects data's issues.
    
    Returns:
    
    UserMapper containing user id's that are required.
  - getProjectRoleActorMapper
```
ProjectRoleActorMapper getProjectRoleActorMapper()
```
    Gets a ProjectRoleActorMapper which, when fully populated, indicates all the ProjectRoleActors "in-use" (optional) by the backup projects data's issues.
    
    Returns:
    
    ProjectRoleActorMapper containing ExternalProjectRoleActors that are in use.
  - getGroupMapper
```
GroupMapper getGroupMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the groups "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "jira-developers", "jira-administrators", etc.) for groups and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing user id's that are required.
  - getStatusMapper
```
StatusMapper getStatusMapper()
```
    Gets a StatusMapper which, when fully populated, indicates all the issue statuses "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "In Progress", "Open", etc.) for all statuses and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    StatusMapper containing issue status information.
  - getPriorityMapper
```
SimpleProjectImportIdMapper getPriorityMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue priorities "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Blocker", "Critical", etc.) for all priorities and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing issue priority information.
  - getIssueTypeMapper
```
IssueTypeMapper getIssueTypeMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue issue types "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Bug", "Task", etc.) for all issue types and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing issue issue type information.
  - getResolutionMapper
```
SimpleProjectImportIdMapper getResolutionMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue resolutions "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Fixed", "Won't Fix", etc.) for all resolutions and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing issue resolution information.
  - getIssueSecurityLevelMapper
```
SimpleProjectImportIdMapper getIssueSecurityLevelMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the issue security levels "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Level 1", "Level 2", etc.) for all issue security levels that are valid for the backup project as defined by the backup projects issue security scheme. The mapper will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing issue security level information.
  - getVersionMapper
```
SimpleProjectImportIdMapper getVersionMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the project versions "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Version 3.1.2", "Version 3.2.1", etc.) for all affects and fix versions and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing issue fix and affects version information.
  - getComponentMapper
```
SimpleProjectImportIdMapper getComponentMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the project components "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Comp 1", "Comp 2", etc.) for all components and will indicate which are in-use by the backup data's issues.
    
    Returns:
    
    ProjectImportIdMapper containing project components information.
  - getProjectRoleMapper
```
SimpleProjectImportIdMapper getProjectRoleMapper()
```
    Gets a ProjectImportIdMapper which, when fully populated, indicates all the project roles "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "Developer", "Administrator", etc.) for all project roles and will indicate which are in-use by the backup data's comments and worklogs.
    
    Returns:
    
    ProjectImportIdMapper containing project role information.
  - getCustomFieldMapper
```
CustomFieldMapper getCustomFieldMapper()
```
    Gets a CustomFieldMapper which, when fully populated, indicates all the custom fields "in-use" (required) by the backup projects data. The mapper will contain the id and key (e.g. "My Text CF", "Extra Reporter CF", etc.) for custom fields that are valid for the backup project as defined by the custom fields configuration. The mapper will indicate which are in-use by the backup data's issues. The mapper will also indicate which issue types are in use for a given custom field.
    
    Returns:
    
    CustomFieldMapper containing custom field information.
  - getCustomFieldOptionMapper
```
CustomFieldOptionMapper getCustomFieldOptionMapper()
```
    Gets a CustomFieldOptionMapper which, when fully populated, indicates how to map the IDs of the Custom Field Options in the Import file, to the equivalent Option in the current JIRA.
    
    Returns:
    
    CustomFieldOptionMapper containing custom field option mapping information.
  - getIssueMapper
```
SimpleProjectImportIdMapper getIssueMapper()
```
    Gets a ProjectImportIdMapper that maps the issue id's from the old backup project data to the id's generated when adding the issue data to the new JIRA instance.
    NOTE: This is only populated once the issues have been persisted into the new system.
    
    Returns:
    
    a ProjectImportIdMapper that maps JIRA issue id's from old to new.
  - getIssueLinkTypeMapper
```
IssueLinkTypeMapper getIssueLinkTypeMapper()
```
    Gets a ProjectImportIdMapper that maps the IssueLinkType id's from the old backup project data to the id's in the current system.
    
    Returns:
    
    a ProjectImportIdMapper that maps IssueLinkType id's from old to new.
  - getChangeGroupMapper
```
SimpleProjectImportIdMapper getChangeGroupMapper()
```
    Gets a ProjectImportIdMapper that maps the change group id's from the old backup project data to the id's generated when adding the change group data to the new JIRA instance.
    NOTE: This is only populated once the change groups have been persisted into the new system.
    
    Returns:
    
    a ProjectImportIdMapper that maps JIRA change group id's from old to new.
  - getCommentMapper
```
SimpleProjectImportIdMapper getCommentMapper()
```
    Gets a ProjectImportIdMapper that maps the Comment id's from the old backup project data to the id's in the current system.
    
    Returns:
    
    a ProjectImportIdMapper that maps JIRA comment id's from old to new.
  - putNamedIdMapper
```
ProjectImportIdMapper putNamedIdMapper(String name,
                                       ProjectImportIdMapper mapper)
```
    Add a mapper to the list of mappers. This can be used by plugins to register their id mappers.
    
    Parameters:
    
    name - The name for this mapper. Plugins should namespace their mappers to avoid conflicts.
    
    mapper - A ProjectImportIdMapper
    
    Returns:
    
    The mapper.
  - getNamedIdMapper
```
<T extends ProjectImportIdMapper> T getNamedIdMapper(String name)
```
    Get a mapper from the list of mappers. This can be used by plugins to retrieve their id mappers.
    
    Parameters:
    
    name - The name for this mapper. Plugins should namespace their mappers to avoid conflicts.
    
    Returns:
    
    The mapper.
  - clearMappedValues
```
void clearMappedValues()
```
    This will clear any mapped data that may have been entered into the mappers. All registered values and values that have been flagged as required will not be changed. This method only affects the mapped data. It is used to re-map and re-validate the data after the user has made changes to the current configuration.

Interface ProjectImportMapper

Method Summary

Method Detail

getProjectMapper

getUserMapper

getProjectRoleActorMapper

getGroupMapper

getStatusMapper

getPriorityMapper

getIssueTypeMapper

getResolutionMapper

getIssueSecurityLevelMapper

getVersionMapper

getComponentMapper

getProjectRoleMapper

getCustomFieldMapper

getCustomFieldOptionMapper

getIssueMapper

getIssueLinkTypeMapper

getChangeGroupMapper

getCommentMapper

putNamedIdMapper

getNamedIdMapper

clearMappedValues