Class ProjectImportResultsImpl
java.lang.Object
com.atlassian.jira.imports.project.core.ProjectImportResultsImpl
- All Implemented Interfaces:
ProjectImportResults
,Serializable
- Since:
- v3.13
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionProjectImportResultsImpl
(long startTime, int expectedIssuesCreatedCount, int expectedUsersCreatedCount, int expectedAttachmentsCreatedCount, I18nHelper i18n) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns false if the number of allowed errors have been exceeded, true otherwisevoid
Adds the given Error message to the error list.void
Add an import result.int
Returns the number of created attachments.Returns a list of all the errors that were added to this result object.int
Returns the number of attachments the import expected it could create before doing the actual import.int
Returns the number of issues the import expected it could create before doing the actual import.int
Returns the number of users the import expected it could create before doing the actual import.int
getGroupsCreatedCountForRole
(String roleName) Returns the count of all groups added to the specified rolegetI18n()
Returns theI18nHelper
associated with this Project Import.long
This uses the start time and the end time to determine how long the actual import took.Returns the created/updated project that the import imported into.int
Returns the number of created issues.Get the results.getRoles()
Returns the role names of all roles that have had a group or user added to it.int
Returns the number of created users.int
getUsersCreatedCountForRole
(String roleName) Returns the count of all users added to the specified rolevoid
Adds to the count of created attachments.void
Adds to the count of created issues.void
incrementRoleGroupCreatedCount
(String roleName) Should be called to increment the count of groups added to a specific role.void
incrementRoleUserCreatedCount
(String roleName) Should be called to increment the count of users added to a specific role.void
Adds to the count of created users.boolean
Returns true if the import completed all steps of the import, false otherwise.void
setEndTime
(long endTime) The time, as milliseconds, that the import ended.void
setImportCompleted
(boolean importCompleted) Should be called with true if all steps of the import were able to proceed (i.e.void
setImportedProject
(Project importedProject) Sets the imported project, this is the project that exists in JIRA.
-
Constructor Details
-
ProjectImportResultsImpl
public ProjectImportResultsImpl(long startTime, int expectedIssuesCreatedCount, int expectedUsersCreatedCount, int expectedAttachmentsCreatedCount, I18nHelper i18n)
-
-
Method Details
-
getImportDuration
public long getImportDuration()Description copied from interface:ProjectImportResults
This uses the start time and the end time to determine how long the actual import took.- Specified by:
getImportDuration
in interfaceProjectImportResults
- Returns:
- number of milliseconds the import took to run.
- See Also:
-
setEndTime
public void setEndTime(long endTime) Description copied from interface:ProjectImportResults
The time, as milliseconds, that the import ended. This must be set in order to get the import duration.- Specified by:
setEndTime
in interfaceProjectImportResults
- Parameters:
endTime
- the time the import has stopped in milliseconds- See Also:
-
incrementRoleUserCreatedCount
Description copied from interface:ProjectImportResults
Should be called to increment the count of users added to a specific role.- Specified by:
incrementRoleUserCreatedCount
in interfaceProjectImportResults
- Parameters:
roleName
- uniquely identifies the project role by its human readable name, this should not be the role id.- See Also:
-
incrementRoleGroupCreatedCount
Description copied from interface:ProjectImportResults
Should be called to increment the count of groups added to a specific role.- Specified by:
incrementRoleGroupCreatedCount
in interfaceProjectImportResults
- Parameters:
roleName
- uniquely identifies the project role by its human readable name, this should not be the role id.- See Also:
-
getRoles
Description copied from interface:ProjectImportResults
Returns the role names of all roles that have had a group or user added to it.- Specified by:
getRoles
in interfaceProjectImportResults
- Returns:
- the role names of all roles that have had a group or user added to it.
-
getGroupsCreatedCountForRole
Description copied from interface:ProjectImportResults
Returns the count of all groups added to the specified role- Specified by:
getGroupsCreatedCountForRole
in interfaceProjectImportResults
- 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
Description copied from interface:ProjectImportResults
Returns the count of all users added to the specified role- Specified by:
getUsersCreatedCountForRole
in interfaceProjectImportResults
- 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
Description copied from interface:ProjectImportResults
Adds the given Error message to the error list. If the error limit is reached, then we throw anAbortImportException
to stop the import.- Specified by:
addError
in interfaceProjectImportResults
- Parameters:
error
- the error message.
-
getErrors
Description copied from interface:ProjectImportResults
Returns a list of all the errors that were added to this result object.- Specified by:
getErrors
in interfaceProjectImportResults
- Returns:
- a list of all the errors that were added to this result object.
-
isImportCompleted
public boolean isImportCompleted()Description copied from interface:ProjectImportResults
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.- Specified by:
isImportCompleted
in interfaceProjectImportResults
- Returns:
- true if the import completed all steps of the import, false otherwise.
-
incrementIssuesCreatedCount
public void incrementIssuesCreatedCount()Description copied from interface:ProjectImportResults
Adds to the count of created issues.- Specified by:
incrementIssuesCreatedCount
in interfaceProjectImportResults
-
incrementUsersCreatedCount
public void incrementUsersCreatedCount()Description copied from interface:ProjectImportResults
Adds to the count of created users.- Specified by:
incrementUsersCreatedCount
in interfaceProjectImportResults
-
incrementAttachmentsCreatedCount
public void incrementAttachmentsCreatedCount()Description copied from interface:ProjectImportResults
Adds to the count of created attachments.- Specified by:
incrementAttachmentsCreatedCount
in interfaceProjectImportResults
-
getIssuesCreatedCount
public int getIssuesCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of created issues.- Specified by:
getIssuesCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of created issues.
-
getUsersCreatedCount
public int getUsersCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of created users.- Specified by:
getUsersCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of created users.
-
getAttachmentsCreatedCount
public int getAttachmentsCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of created attachments.- Specified by:
getAttachmentsCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of created attachments.
-
getExpectedIssuesCreatedCount
public int getExpectedIssuesCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of issues the import expected it could create before doing the actual import.- Specified by:
getExpectedIssuesCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of issues the import expected it could create before doing the actual import.
-
getExpectedUsersCreatedCount
public int getExpectedUsersCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of users the import expected it could create before doing the actual import.- Specified by:
getExpectedUsersCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of users the import expected it could create before doing the actual import.
-
getExpectedAttachmentsCreatedCount
public int getExpectedAttachmentsCreatedCount()Description copied from interface:ProjectImportResults
Returns the number of attachments the import expected it could create before doing the actual import.- Specified by:
getExpectedAttachmentsCreatedCount
in interfaceProjectImportResults
- Returns:
- the number of attachments the import expected it could create before doing the actual import.
-
setImportCompleted
public void setImportCompleted(boolean importCompleted) Description copied from interface:ProjectImportResults
Should be called with true if all steps of the import were able to proceed (i.e. no AbortImportException was thrown).- Specified by:
setImportCompleted
in interfaceProjectImportResults
- Parameters:
importCompleted
- true if completed, false otherwise.
-
getImportedProject
Description copied from interface:ProjectImportResults
Returns the created/updated project that the import imported into.- Specified by:
getImportedProject
in interfaceProjectImportResults
- Returns:
- the created/updated project that the import imported into.
-
setImportedProject
Description copied from interface:ProjectImportResults
Sets the imported project, this is the project that exists in JIRA.- Specified by:
setImportedProject
in interfaceProjectImportResults
- Parameters:
importedProject
- the imported project, this is the project that exists in JIRA.
-
getI18n
Description copied from interface:ProjectImportResults
Returns theI18nHelper
associated with this Project Import. This can be used to localise error messages before they are added in this ProjectImportResult.- Specified by:
getI18n
in interfaceProjectImportResults
- Returns:
- the
I18nHelper
associated with this Project Import.
-
abortImport
public boolean abortImport()Description copied from interface:ProjectImportResults
Returns false if the number of allowed errors have been exceeded, true otherwise- Specified by:
abortImport
in interfaceProjectImportResults
- Returns:
- false if the number of allowed errors have been exceeded, true otherwise
-
addResult
Description copied from interface:ProjectImportResults
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.- Specified by:
addResult
in interfaceProjectImportResults
- Parameters:
count
- Number of objects importedmsgKey
- Key to a label message for the objects imported
-
getResults
Description copied from interface:ProjectImportResults
Get the results. The results consist of aPair
consisting of a resolved description and the number of those objects imported.e.g.
- Rapid Boards, 12
- Sprints, 2765
- Specified by:
getResults
in interfaceProjectImportResults
- Returns:
- Iterable of result messages.
-