com.atlassian.jira.imports.project.core
Interface ProjectImportOptions

All Known Implementing Classes:
ProjectImportOptionsImpl

public interface ProjectImportOptions

Contains user inputed options related to the project import.

Since:
v3.13

Method Summary
 String getAttachmentPath()
          Specifies the path, on disk on the server, to the directory that will contain the attachments for the project data that will be restored.
 String getPathToBackupXml()
          Specifies the path, on disk on the server, to the backup XML data file that will contain the project data that will be restored.
 String getSelectedProjectKey()
          The project key that the user has chosen to import.
 boolean overwriteProjectDetails()
          A boolean that indicates if the user wants the existing JIRA project, which is being imported into, to have its project details (name, lead, etc) over-written by the backup projects data.
 

Method Detail

getPathToBackupXml

String getPathToBackupXml()
Specifies the path, on disk on the server, to the backup XML data file that will contain the project data that will be restored.

Returns:
the file path on disk to the backup XML file.

getAttachmentPath

String getAttachmentPath()
Specifies the path, on disk on the server, to the directory that will contain the attachments for the project data that will be restored.

Returns:
the file path on disk to the attachments directory.

overwriteProjectDetails

boolean overwriteProjectDetails()
A boolean that indicates if the user wants the existing JIRA project, which is being imported into, to have its project details (name, lead, etc) over-written by the backup projects data. NOTE: If the project does not yet exist the importer will work as if this value is set to true, no matter what the value really is.

Returns:
true if we want to overwrite the project details, false otherwise

getSelectedProjectKey

String getSelectedProjectKey()
The project key that the user has chosen to import.

Returns:
project key that the user has chosen to import.


Copyright © 2002-2013 Atlassian. All Rights Reserved.