@PublicApi public interface ConfigurationReferenceCollector
ConfigurationReferenceLookup
.
It's the callers responsibility to provide unique keys - keys must be unique for the type of the configuration object - for example the
same key can be used for a status and a priority. Any duplicate keys will override the referred object.
Null keys are not allowed. Null references will produce an audit and JIRA log warning and will not halt the export procedure.ConfigurationReferenceLookup
Modifier and Type | Method and Description |
---|---|
void |
collectAgileBoard(String key,
Long agileBoardId)
Collects an Agile Board reference.
|
void |
collectEventType(String key,
com.atlassian.jira.event.type.EventType reference)
Collects a
EventType reference. |
void |
collectField(String key,
com.atlassian.jira.issue.fields.Field reference)
Collects a
Field reference. |
void |
collectFieldContext(String key,
com.atlassian.jira.issue.fields.config.FieldConfigScheme fieldConfigScheme)
Collects a
FieldConfigScheme reference. |
void |
collectFieldLayoutScheme(String key,
com.atlassian.jira.issue.fields.layout.field.FieldLayoutScheme fieldLayoutScheme)
Collects a
FieldLayoutScheme reference. |
void |
collectFieldOption(String key,
com.atlassian.jira.issue.customfields.option.Option reference)
Collects an
Option reference. |
void |
collectFieldScreenScheme(String key,
com.atlassian.jira.issue.fields.screen.FieldScreenScheme fieldScreenScheme)
Collects a
FieldScreenScheme reference. |
void |
collectGroup(String key,
com.atlassian.crowd.embedded.api.Group reference)
Collects a
Group reference. |
void |
collectIssueLinkType(String key,
com.atlassian.jira.issue.link.IssueLinkType reference)
Collects an
IssueLinkType reference. |
void |
collectIssueType(String key,
com.atlassian.jira.issue.issuetype.IssueType reference)
Collects an
IssueType reference. |
void |
collectIssueTypeScheme(String key,
com.atlassian.jira.issue.fields.config.FieldConfigScheme issueTypeScheme)
Collects a
FieldConfigScheme reference. |
void |
collectIssueTypeScreenScheme(String key,
com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenScheme issueTypeScreenScheme)
Collects a
IssueTypeScreenScheme reference. |
void |
collectJiraWorkflow(String key,
com.atlassian.jira.workflow.JiraWorkflow jiraWorkflow)
Collects a
JiraWorkflow reference. |
void |
collectPriority(String key,
com.atlassian.jira.issue.priority.Priority reference)
Collects a
Priority reference. |
void |
collectProject(String key,
com.atlassian.jira.project.Project project)
Collects a
Project reference. |
void |
collectProjectComponent(String key,
com.atlassian.jira.bc.project.component.ProjectComponent projectComponent)
Collects a
ProjectComponent reference. |
void |
collectProjectRole(String key,
com.atlassian.jira.security.roles.ProjectRole projectRole)
Collects a
ProjectRole reference. |
void |
collectProjectVersion(String key,
com.atlassian.jira.project.version.Version projectVersion)
Collects a
Version reference. |
void |
collectQuery(String key,
com.atlassian.query.Query query)
Collects a
Query reference. |
void |
collectRequestType(String key,
Long requestTypeId)
Collects a Request Type reference.
|
void |
collectResolution(String key,
com.atlassian.jira.issue.resolution.Resolution reference)
Collects a
Resolution reference. |
void |
collectSearchRequest(String key,
com.atlassian.jira.issue.search.SearchRequest reference)
Collects a
SearchRequest reference. |
void |
collectSecurityLevel(String key,
com.atlassian.jira.issue.security.IssueSecurityLevel securityLevel)
Collects a
IssueSecurityLevel reference. |
void |
collectSprint(String key,
Long sprintId)
Collects a Sprint reference.
|
void |
collectStatus(String key,
com.atlassian.jira.issue.status.Status reference)
Collects a
Status reference. |
void |
collectUser(String key,
com.atlassian.jira.user.ApplicationUser reference)
Collects an
ApplicationUser reference. |
void |
collectWorkflowScheme(String key,
com.atlassian.jira.scheme.Scheme workflowScheme)
Collects a
Scheme reference. |
void collectField(String key, com.atlassian.jira.issue.fields.Field reference)
Field
reference. Field can be either a CustomField
or a Field
(representing a system field).
A list of System ("built-in") fields can be found here:
https://confluence.atlassian.com/adminjiraserver073/configuring-built-in-fields-861253234.html
Null references are ignored and will produce an audit and JIRA log warnings.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Field
void collectFieldOption(String key, com.atlassian.jira.issue.customfields.option.Option reference)
Option
reference.
Null references are ignored and will produce an audit and JIRA log warnings.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Option
void collectFieldContext(String key, com.atlassian.jira.issue.fields.config.FieldConfigScheme fieldConfigScheme)
FieldConfigScheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred FieldConfigScheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.fieldConfigScheme
- The referred JIRA FieldConfigScheme
void collectUser(String key, com.atlassian.jira.user.ApplicationUser reference)
ApplicationUser
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred ApplicationUser
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA ApplicationUser
void collectGroup(String key, com.atlassian.crowd.embedded.api.Group reference)
Group
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Group
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Group
void collectIssueType(String key, com.atlassian.jira.issue.issuetype.IssueType reference)
IssueType
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred IssueType
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA IssueType
void collectIssueLinkType(String key, com.atlassian.jira.issue.link.IssueLinkType reference)
IssueLinkType
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred IssueLinkType
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA IssueLinkType
void collectStatus(String key, com.atlassian.jira.issue.status.Status reference)
Status
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Status
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Status
void collectResolution(String key, com.atlassian.jira.issue.resolution.Resolution reference)
Resolution
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Resolution
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Resolution
void collectPriority(String key, com.atlassian.jira.issue.priority.Priority reference)
Priority
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Priority
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA Priority
void collectEventType(String key, com.atlassian.jira.event.type.EventType reference)
EventType
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred EventType
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA EventType
void collectSearchRequest(String key, com.atlassian.jira.issue.search.SearchRequest reference)
SearchRequest
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred SearchRequest
via the JIRA API. The referred SearchRequest
should be either global or the user initiating the export should have access to it, otherwise lookup will fail.
In some cases a SearchRequest
might have "broken" JQL (e.x. if it refers a project which has been deleted). In these cases an
audit warning will be added.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.reference
- The referred JIRA SearchRequest
void collectQuery(String key, com.atlassian.query.Query query)
Query
reference. A query is treated as a JQL string which is checked for validity. In case the query refers an
object that is no-longer present or has an invalid syntax an audit warning will be created and the export process will continue.
Null references are ignored and will produce audit and JIRA log warnings.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.query
- The referred JIRA Query
void collectProject(String key, com.atlassian.jira.project.Project project)
Project
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Project
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.project
- The referred JIRA Project
void collectProjectVersion(String key, com.atlassian.jira.project.version.Version projectVersion)
Version
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Version
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.projectVersion
- The referred JIRA Version
void collectProjectComponent(String key, com.atlassian.jira.bc.project.component.ProjectComponent projectComponent)
ProjectComponent
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred ProjectComponent
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.projectComponent
- The referred JIRA ProjectComponent
void collectProjectRole(String key, com.atlassian.jira.security.roles.ProjectRole projectRole)
ProjectRole
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred ProjectRole
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.projectRole
- The referred JIRA ProjectRole
void collectRequestType(String key, Long requestTypeId)
key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.requestTypeId
- The referred JIRA Request type idvoid collectSecurityLevel(String key, com.atlassian.jira.issue.security.IssueSecurityLevel securityLevel)
IssueSecurityLevel
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred IssueSecurityLevel
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.securityLevel
- The referred JIRA IssueSecurityLevel
void collectSprint(String key, Long sprintId)
key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.sprintId
- The referred JIRA Sprint idvoid collectAgileBoard(String key, Long agileBoardId)
key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.agileBoardId
- The referred JIRA Agile Board idvoid collectJiraWorkflow(String key, com.atlassian.jira.workflow.JiraWorkflow jiraWorkflow)
JiraWorkflow
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred JiraWorkflow
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.jiraWorkflow
- The referred JIRA JiraWorkflow
void collectWorkflowScheme(String key, com.atlassian.jira.scheme.Scheme workflowScheme)
Scheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred Scheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.workflowScheme
- The referred JIRA Scheme
void collectIssueTypeScheme(String key, com.atlassian.jira.issue.fields.config.FieldConfigScheme issueTypeScheme)
FieldConfigScheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred FieldConfigScheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.issueTypeScheme
- The referred JIRA FieldConfigScheme
void collectIssueTypeScreenScheme(String key, com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenScheme issueTypeScreenScheme)
IssueTypeScreenScheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred IssueTypeScreenScheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.issueTypeScreenScheme
- The referred JIRA IssueTypeScreenScheme
void collectFieldScreenScheme(String key, com.atlassian.jira.issue.fields.screen.FieldScreenScheme fieldScreenScheme)
FieldScreenScheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred FieldScreenScheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.fieldScreenScheme
- The referred JIRA FieldScreenScheme
void collectFieldLayoutScheme(String key, com.atlassian.jira.issue.fields.layout.field.FieldLayoutScheme fieldLayoutScheme)
FieldLayoutScheme
reference. Null references are ignored and will produce an audit and JIRA log warnings.
Implementing classes will try to lookup the referred FieldLayoutScheme
via the JIRA API.key
- A key uniquely identifying referred object. Caller should make sure keys are unique across method calls, unless caller's
intent is overriding the reference.fieldLayoutScheme
- The referred JIRA FieldLayoutScheme
Copyright © 2022. All rights reserved.