Package com.atlassian.jira.bc.issue.fields

Interface FieldConfigSchemeService

All Known Implementing Classes:
FieldConfigSchemeServiceImpl
@Internal @ParametersAreNonnullByDefault @ReturnValuesAreNonnullByDefault public interface FieldConfigSchemeService
Since:
8.16

  • Method Details

    • getFieldConfigScheme

      ServiceOutcome<FieldConfigScheme> getFieldConfigScheme(@Nonnull ApplicationUser user, String fieldId, long configSchemeId)
      Parameters:
      user - User performing operation.
      fieldId - Field id.
      configSchemeId - Id of field config scheme to get.
      Returns:
      Service outcome containing data of field config scheme.

    • getFieldConfigSchemesForField

      ServiceOutcome<List<FieldConfigScheme>> getFieldConfigSchemesForField(@Nonnull ApplicationUser user, String fieldId)
      Parameters:
      user - User performing operation.
      fieldId - Field id
      Returns:
      Service outcome containing field config schemes for field.

    • createFieldConfigScheme

      ServiceOutcome<FieldConfigScheme> createFieldConfigScheme(@Nonnull ApplicationUser user, FieldConfigSchemeParameters parameters)
      Creates new field configuration scheme.
      Parameters:
      user - User performing operation.
      parameters - Data of field config scheme to create.
      Returns:
      service outcome containing data of created field config scheme.

    • updateFieldConfigScheme

      ServiceOutcome<FieldConfigScheme> updateFieldConfigScheme(@Nonnull ApplicationUser user, FieldConfigSchemeParameters parameters)
      Updates field configuration scheme,
      Parameters:
      user - User performing operation.
      parameters - Target data of field config scheme to update.
      Returns:
      service outcome containing data of updated field config scheme.

    • deleteFieldConfigScheme

      ServiceResult deleteFieldConfigScheme(@Nonnull ApplicationUser loggedInUser, String fieldId, long configSchemeId)
      Deletes field configuration scheme,
      Parameters:
      loggedInUser - User performing operation.
      fieldId - Field id of field associated with configuration scheme to delete
      configSchemeId - Id of configuration scheme to delete
      Returns:
      outcome of operation.

    • getAvailableProjectsForUpdate

      ServiceOutcome<List<Project>> getAvailableProjectsForUpdate(@Nonnull ApplicationUser loggedInUser, String fieldId, long configSchemeId)
      Gets list of available projects that can be used for updating existing field context for passed fieldId and configSchemeId.
      Parameters:
      loggedInUser - User performing operation.
      fieldId - Field id
      configSchemeId -
      Returns:
      list of available projects that can be used for updating existing field context for passed fieldId and configSchemeId.

    • isGlobalAvailableForUpdate

      ServiceOutcome<Boolean> isGlobalAvailableForUpdate(@Nonnull ApplicationUser loggedInUser, String fieldId, long configSchemeId)
      Checks if existing field context for passed fieldId and configSchemeId can be configured as "global" context. Global context for update operation should be available when either no global context is configured for any field config scheme associated with field or updated field context scheme is configured as global scheme.
      Parameters:
      loggedInUser - User performing operation.
      fieldId - Field id
      configSchemeId -
      Returns:
      true if existing field context for passed fieldId and configSchemeId can be configured as "global" context, false otherwise.

    • getAvailableProjectsForCreate

      ServiceOutcome<List<Project>> getAvailableProjectsForCreate(@Nonnull ApplicationUser loggedInUser, String fieldId)
      Gets list of available projects that can be used for new field context for passed fieldId.
      Parameters:
      loggedInUser - User performing operation.
      fieldId - Field id
      Returns:
      list of available projects that can be used for new field context for passed fieldId.

    • isGlobalAvailableForCreate

      ServiceOutcome<Boolean> isGlobalAvailableForCreate(@Nonnull ApplicationUser loggedInUser, String fieldId)
      Checks if new field context for passed fieldId can be configured as "global" context. Global context for create is available when no global context is configured for any field config scheme associated with field.
      Parameters:
      loggedInUser - User performing operation.
      fieldId - Field id
      Returns:
      true if new field context for passed fieldId can be configured as "global" context, false otherwise.