com.atlassian.jira.imports.project.core

Interface BackupProject

All Known Implementing Classes:

BackupProjectImpl

public interface BackupProject

Represents information about a single project gleaned from an XML backup.

Since:

v3.13

Method Summary

Modifier and Type	Method and Description
boolean	containsIssue(String id)
Collection<Object>	getAdditionalData(String key) Get additional data stored against this key.
ExternalCustomFieldConfiguration	getCustomFieldConfiguration(String customFieldId) Deprecated. use getCustomFieldConfigurations(String)
Collection<ExternalCustomFieldConfiguration>	getCustomFieldConfigurations(String customFieldId)
Collection<ExternalCustomFieldConfiguration>	getCustomFields()
Collection<Long>	getIssueIds()
ExternalProject	getProject()
Collection<ExternalComponent>	getProjectComponents()
Collection<ExternalVersion>	getProjectVersions()
int	getSystemFieldMaxTextLength() Get maximum length of text system fields found in this project.

Method Detail

getProject

ExternalProject getProject()

Returns:

the ExternalProject that is represented in the XML backup.

getProjectVersions

Collection<ExternalVersion> getProjectVersions()

Returns:

the ExternalVersion's that are associated with the project returned from getProject().

getProjectComponents

Collection<ExternalComponent> getProjectComponents()

Returns:

the ExternalComponent's that are associated with the project returned from getProject().

getIssueIds

Collection<Long> getIssueIds()

Returns:

the issue id's that are associated with the project returned from getProject().

getCustomFields

Collection<ExternalCustomFieldConfiguration> getCustomFields()

Returns:

the ExternalCustomFieldConfiguration's that describe the custom fields and their configurations for this project.

getCustomFieldConfiguration

@Deprecated
ExternalCustomFieldConfiguration getCustomFieldConfiguration(String customFieldId)

Deprecated. use getCustomFieldConfigurations(String)

Parameters:

customFieldId - the id of the custom field configuration to retrieve

Returns:

the ExternalCustomFieldConfiguration for the custom field with the specified id, null if the project does not have the custom field with the id.

getCustomFieldConfigurations

Collection<ExternalCustomFieldConfiguration> getCustomFieldConfigurations(String customFieldId)

Parameters:

customFieldId - the id of the custom field configuration to retrieve

Returns:

the Collection of applicable ExternalCustomFieldConfiguration for the custom field with the specified id, empty collection if the project does not have the custom field with the id.

containsIssue

boolean containsIssue(String id)

Parameters:

id - an issue id that can be converted to a Long

Returns:

true if the backup project contains the issue, false otherwise.

getAdditionalData

Collection<Object> getAdditionalData(String key)

Get additional data stored against this key.

Plugins should namespace keys appropriately to ensure they can store data uniquely.

Plugins would typically store information about what configuration items are used and may be required by items that will be related.

For example: A Plugin that provides Test Planning, might store any Test Plans that are referenced by the issues being imported.

Parameters:

key - Key under which this data is stored.

Returns:

Collection of data stored under this key.

getSystemFieldMaxTextLength

int getSystemFieldMaxTextLength()

Get maximum length of text system fields found in this project. Used to check if imported project does not exceed jira character limit setting.

Returns:

maximum length of issue description, environment, comment or text custom field or 0 if project is empty