Package com.atlassian.jira.imports.project.core

Interface ProjectImportResults

All Superinterfaces:
Serializable
All Known Implementing Classes:
ProjectImportResultsImpl
public interface ProjectImportResults extends Serializable
Used to store the results of the actual importing of the project. This includes statistics on what was created and any error messages that may have been generated during the import.
Since:
v3.13

  • Method Details

    • getImportDuration

      long getImportDuration()
      This uses the start time and the end time to determine how long the actual import took.
      Returns:
      number of milliseconds the import took to run.
      See Also:

    • setEndTime

      void setEndTime(long endTime)
      The time, as milliseconds, that the import ended. This must be set in order to get the import duration.
      Parameters:
      endTime - the time the import has stopped in milliseconds
      See Also:

    • incrementRoleUserCreatedCount

      void incrementRoleUserCreatedCount(String roleName)
      Should be called to increment the count of users added to a specific role.
      Parameters:
      roleName - uniquely identifies the project role by its human readable name, this should not be the role id.
      See Also:

    • incrementRoleGroupCreatedCount

      void incrementRoleGroupCreatedCount(String roleName)
      Should be called to increment the count of groups added to a specific role.
      Parameters:
      roleName - uniquely identifies the project role by its human readable name, this should not be the role id.
      See Also:

    • getRoles

      Collection<String> getRoles()
      Returns the role names of all roles that have had a group or user added to it.
      Returns:
      the role names of all roles that have had a group or user added to it.

    • getGroupsCreatedCountForRole

      int getGroupsCreatedCountForRole(String roleName)
      Returns the count of all groups added to the specified role
      Parameters:
      roleName - the role you want the count for, this should be the role name as provided in the increment method
      Returns:
      the count of all groups added to the specified role

    • getUsersCreatedCountForRole

      int getUsersCreatedCountForRole(String roleName)
      Returns the count of all users added to the specified role
      Parameters:
      roleName - the role you want the count for, this should be the role name as provided in the increment method
      Returns:
      the count of all users added to the specified role

    • addError

      void addError(String error)
      Adds the given Error message to the error list. If the error limit is reached, then we throw an AbortImportException to stop the import.
      Parameters:
      error - the error message.

    • getErrors

      List<String> getErrors()
      Returns a list of all the errors that were added to this result object.
      Returns:
      a list of all the errors that were added to this result object.

    • isImportCompleted

      boolean isImportCompleted()
      Returns true if the import completed all steps of the import, false otherwise. This method can return true and the getErrors can return errors. This will not return true if the errors went over the allowable threshold, and the Import was aborted.
      Returns:
      true if the import completed all steps of the import, false otherwise.

    • incrementIssuesCreatedCount

      void incrementIssuesCreatedCount()
      Adds to the count of created issues.

    • incrementUsersCreatedCount

      void incrementUsersCreatedCount()
      Adds to the count of created users.

    • incrementAttachmentsCreatedCount

      void incrementAttachmentsCreatedCount()
      Adds to the count of created attachments.

    • getIssuesCreatedCount

      int getIssuesCreatedCount()
      Returns the number of created issues.
      Returns:
      the number of created issues.

    • getUsersCreatedCount

      int getUsersCreatedCount()
      Returns the number of created users.
      Returns:
      the number of created users.

    • getAttachmentsCreatedCount

      int getAttachmentsCreatedCount()
      Returns the number of created attachments.
      Returns:
      the number of created attachments.

    • getExpectedIssuesCreatedCount

      int getExpectedIssuesCreatedCount()
      Returns the number of issues the import expected it could create before doing the actual import.
      Returns:
      the number of issues the import expected it could create before doing the actual import.

    • getExpectedUsersCreatedCount

      int getExpectedUsersCreatedCount()
      Returns the number of users the import expected it could create before doing the actual import.
      Returns:
      the number of users the import expected it could create before doing the actual import.

    • getExpectedAttachmentsCreatedCount

      int getExpectedAttachmentsCreatedCount()
      Returns the number of attachments the import expected it could create before doing the actual import.
      Returns:
      the number of attachments the import expected it could create before doing the actual import.

    • setImportCompleted

      void setImportCompleted(boolean importCompleted)
      Should be called with true if all steps of the import were able to proceed (i.e. no AbortImportException was thrown).
      Parameters:
      importCompleted - true if completed, false otherwise.

    • getImportedProject

      Project getImportedProject()
      Returns the created/updated project that the import imported into.
      Returns:
      the created/updated project that the import imported into.

    • setImportedProject

      void setImportedProject(Project importedProject)
      Sets the imported project, this is the project that exists in JIRA.
      Parameters:
      importedProject - the imported project, this is the project that exists in JIRA.

    • getI18n

      I18nHelper getI18n()
      Returns the I18nHelper associated with this Project Import. This can be used to localise error messages before they are added in this ProjectImportResult.
      Returns:
      the I18nHelper associated with this Project Import.

    • abortImport

      boolean abortImport()
      Returns false if the number of allowed errors have been exceeded, true otherwise
      Returns:
      false if the number of allowed errors have been exceeded, true otherwise

    • addResult

      void addResult(long count, String msgKey)
      Add an import result. This method is provided to enable plugins to supply counts of items imported. Plugins should try to display only a small amount of the most relevant information so as not to overwhelm the user and clutter the results.
      Parameters:
      count - Number of objects imported
      msgKey - Key to a label message for the objects imported

    • getResults

      @Internal List<io.atlassian.fugue.Pair<String,Long>> getResults()
      Get the results. The results consist of a Pair consisting of a resolved description and the number of those objects imported.

      e.g.

      • Rapid Boards, 12
      • Sprints, 2765
      Returns:
      Iterable of result messages.