@PublicApi public interface ConfigurationReferenceLookup
ConfigurationReferenceCollector
.
Methods return JIRA target instance objects that match objects referred by the ConfigurationReferenceCollector
. Keys are
maintained across source and target JIRA instances.
Methods will return Optional.empty()
if CMJ fails to find a matching object via the JIRA API. In these cases a detailed error
will be logged in the JIRA log.ConfigurationReferenceCollector
Modifier and Type | Method and Description |
---|---|
Optional<Long> |
lookupAgileBoard(String key)
Produces an Agile Board id which corresponds to id of the agile board stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.event.type.EventType> |
lookupEventType(String key)
Looks up a JIRA
EventType by the given key. |
Optional<com.atlassian.jira.issue.fields.Field> |
lookupField(String key)
Looks up a JIRA
Field by the given key. |
Optional<com.atlassian.jira.issue.fields.config.FieldConfigScheme> |
lookupFieldContext(String key)
Produces a JIRA
FieldConfigScheme which corresponds to the FieldConfigScheme stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.fields.layout.field.FieldLayoutScheme> |
lookupFieldLayoutScheme(String key)
Produces a JIRA
FieldLayoutScheme which corresponds to the FieldLayoutScheme stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.customfields.option.Option> |
lookupFieldOption(String key)
Looks up a JIRA
Option by the given key. |
Optional<com.atlassian.jira.issue.fields.screen.FieldScreenScheme> |
lookupFieldScreenScheme(String key)
Produces a JIRA
FieldScreenScheme which corresponds to the FieldScreenScheme stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.crowd.embedded.api.Group> |
lookupGroup(String key)
Looks up a JIRA
Group by the given key. |
Optional<com.atlassian.jira.issue.link.IssueLinkType> |
lookupIssueLinkType(String key)
Looks up a JIRA
IssueLinkType by the given key. |
Optional<com.atlassian.jira.issue.issuetype.IssueType> |
lookupIssueType(String key)
Looks up a JIRA
IssueType by the given key. |
Optional<com.atlassian.jira.issue.fields.config.FieldConfigScheme> |
lookupIssueTypeScheme(String key)
Produces a JIRA
FieldConfigScheme which corresponds to the FieldConfigScheme stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenScheme> |
lookupIssueTypeScreenScheme(String key)
Produces a JIRA
IssueTypeScreenScheme which corresponds to the IssueTypeScreenScheme stored by the given key on
export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.workflow.JiraWorkflow> |
lookupJiraWorkflow(String key)
Produces a JIRA
JiraWorkflow which corresponds to the JiraWorkflow stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.priority.Priority> |
lookupPriority(String key)
Looks up a JIRA
Priority by the given key. |
Optional<com.atlassian.jira.project.Project> |
lookupProject(String key)
Produces a JIRA
Project which corresponds to the Project stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.bc.project.component.ProjectComponent> |
lookupProjectComponent(String key)
Produces a JIRA
ProjectComponent which corresponds to the ProjectComponent stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.security.roles.ProjectRole> |
lookupProjectRole(String key)
Produces a JIRA
ProjectRole which corresponds to the ProjectRole stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.project.version.Version> |
lookupProjectVersion(String key)
Produces a JIRA
Version which corresponds to the Version stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.query.Query> |
lookupQuery(String key)
Produces a JIRA
Query which corresponds to the Query stored by the given key on export. |
Optional<Long> |
lookupRequestType(String key)
Produces a Request Type id which corresponds to id of the request type stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.resolution.Resolution> |
lookupResolution(String key)
Looks up a JIRA
Resolution by the given key. |
Optional<com.atlassian.jira.issue.search.SearchRequest> |
lookupSearchRequest(String key)
Looks up a JIRA
SearchRequest by the given key. |
Optional<com.atlassian.jira.issue.security.IssueSecurityLevel> |
lookupSecurityLevel(String key)
Produces a JIRA
IssueSecurityLevel which corresponds to the IssueSecurityLevel stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<Long> |
lookupSprint(String key)
Produces a Sprint id which corresponds to id of the sprint stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.status.Status> |
lookupStatus(String key)
Looks up a JIRA
Status by the given key. |
Optional<com.atlassian.jira.user.ApplicationUser> |
lookupUser(String key)
Looks up a JIRA
ApplicationUser by the given key. |
Optional<com.atlassian.jira.scheme.Scheme> |
lookupWorkflowScheme(String key)
Produces a JIRA
Scheme which corresponds to the Scheme stored by the given key on export
Optional.empty() is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector |
Optional<com.atlassian.jira.issue.fields.Field> lookupField(String key)
Field
by the given key. Returned field can be either a CustomField
or a system (built-in)
Field
depending on type referred via ConfigurationReferenceCollector.collectField(String, Field)
.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer field in ConfigurationReferenceCollector.collectField(String, Field)
callOptional.empty()
if field JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.customfields.option.Option> lookupFieldOption(String key)
Option
by the given key. Returned custom field option that can be a Option
.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer field in ConfigurationReferenceCollector.collectFieldOption(String, Option)
callOptional.empty()
if field JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.fields.config.FieldConfigScheme> lookupFieldContext(String key)
FieldConfigScheme
which corresponds to the FieldConfigScheme
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer custom field context in
ConfigurationReferenceCollector.collectFieldContext(String, FieldConfigScheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.user.ApplicationUser> lookupUser(String key)
ApplicationUser
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer user in ConfigurationReferenceCollector.collectUser(String, ApplicationUser)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.crowd.embedded.api.Group> lookupGroup(String key)
Group
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer filed in ConfigurationReferenceCollector.collectGroup(String, Group)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.issuetype.IssueType> lookupIssueType(String key)
IssueType
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer issue type in ConfigurationReferenceCollector.collectIssueType(String, IssueType)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.link.IssueLinkType> lookupIssueLinkType(String key)
IssueLinkType
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer issue link type in ConfigurationReferenceCollector.collectIssueLinkType(String, IssueLinkType)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.status.Status> lookupStatus(String key)
Status
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer status in ConfigurationReferenceCollector.collectStatus(String, Status)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.resolution.Resolution> lookupResolution(String key)
Resolution
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer resolution in ConfigurationReferenceCollector.collectResolution(String, Resolution)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.priority.Priority> lookupPriority(String key)
Priority
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer priority in ConfigurationReferenceCollector.collectPriority(String, Priority)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.event.type.EventType> lookupEventType(String key)
EventType
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer priority in ConfigurationReferenceCollector.collectEventType(String, EventType)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.search.SearchRequest> lookupSearchRequest(String key)
SearchRequest
by the given key.
Optional.empty()
is returned in case JIRA API lookup fails, in case calling user doesn't have access to the referred
SearchRequest
or if given key was not used in ConfigurationReferenceCollector
key
- Key used to refer filter in ConfigurationReferenceCollector.collectSearchRequest(String, SearchRequest)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.query.Query> lookupQuery(String key)
Query
which corresponds to the Query
stored by the given key on export.
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer JQL string in ConfigurationReferenceCollector.collectQuery(String, Query)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.project.Project> lookupProject(String key)
Project
which corresponds to the Project
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer project in ConfigurationReferenceCollector.collectProject(String, Project)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.project.version.Version> lookupProjectVersion(String key)
Version
which corresponds to the Version
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer project version in ConfigurationReferenceCollector.collectProjectVersion(String, Version)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.bc.project.component.ProjectComponent> lookupProjectComponent(String key)
ProjectComponent
which corresponds to the ProjectComponent
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer project component in
ConfigurationReferenceCollector.collectProjectComponent(String, ProjectComponent)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.security.roles.ProjectRole> lookupProjectRole(String key)
ProjectRole
which corresponds to the ProjectRole
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer project role in ConfigurationReferenceCollector.collectProjectRole(String, ProjectRole)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<Long> lookupRequestType(String key)
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer request type id in ConfigurationReferenceCollector.collectRequestType(String, Long)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.security.IssueSecurityLevel> lookupSecurityLevel(String key)
IssueSecurityLevel
which corresponds to the IssueSecurityLevel
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer security level in
ConfigurationReferenceCollector.collectSecurityLevel(String, IssueSecurityLevel)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<Long> lookupSprint(String key)
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer sprint id in ConfigurationReferenceCollector.collectSprint(String, Long)
} callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
or in case if JIRA Software is not installed.Optional<Long> lookupAgileBoard(String key)
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer agile board id in ConfigurationReferenceCollector.collectAgileBoard(String, Long)
} callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
or in case if JIRA Software is not installed.Optional<com.atlassian.jira.workflow.JiraWorkflow> lookupJiraWorkflow(String key)
JiraWorkflow
which corresponds to the JiraWorkflow
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer workflow in ConfigurationReferenceCollector.collectJiraWorkflow(String, JiraWorkflow)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.scheme.Scheme> lookupWorkflowScheme(String key)
Scheme
which corresponds to the Scheme
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer workflow scheme in ConfigurationReferenceCollector.collectWorkflowScheme(String, Scheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.fields.config.FieldConfigScheme> lookupIssueTypeScheme(String key)
FieldConfigScheme
which corresponds to the FieldConfigScheme
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer issue type scheme in
ConfigurationReferenceCollector.collectIssueTypeScheme(String, FieldConfigScheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenScheme> lookupIssueTypeScreenScheme(String key)
IssueTypeScreenScheme
which corresponds to the IssueTypeScreenScheme
stored by the given key on
export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer issue type screen scheme in
ConfigurationReferenceCollector.collectIssueTypeScreenScheme(String, IssueTypeScreenScheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.fields.screen.FieldScreenScheme> lookupFieldScreenScheme(String key)
FieldScreenScheme
which corresponds to the FieldScreenScheme
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer field screen scheme in
ConfigurationReferenceCollector.collectFieldScreenScheme(String, FieldScreenScheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Optional<com.atlassian.jira.issue.fields.layout.field.FieldLayoutScheme> lookupFieldLayoutScheme(String key)
FieldLayoutScheme
which corresponds to the FieldLayoutScheme
stored by the given key on export
Optional.empty()
is returned in case JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
key
- Key used to refer field layout scheme in
ConfigurationReferenceCollector.collectFieldLayoutScheme(String, FieldLayoutScheme)
callOptional.empty()
if JIRA API lookup fails or if given key was not used in
ConfigurationReferenceCollector
Copyright © 2022. All rights reserved.