Package com.atlassian.greenhopper.manager.rapidview

Interface RapidViewManager

All Superinterfaces:
GreenHopperCache
All Known Implementing Classes:
RapidViewManagerImpl
public interface RapidViewManager extends GreenHopperCache
For operating on RapidView objects

  • Method Details

    • create

      @Transactional ServiceOutcome<RapidView> create(RapidView view, com.atlassian.jira.user.ApplicationUser user, RapidViewPreset preset)
      Persist a new instance of a RapidBoard
      Returns:
      the created RapidView from cache or the error that occurred

    • create

      ServiceOutcome<RapidView> create(com.atlassian.jira.user.ApplicationUser user, String name, Long filterId, RapidViewPreset preset)
      Persist a new instance of a RapidBoard
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      name - the name of the board.
      filterId - the ID of JIRA's SearchRequest that is to be associated with the new view.
      preset - the param which determine initial settings of created rapid view.
      Returns:
      a created rapid view or error if operation failed.

    • delete

      @Transactional ServiceResult delete(RapidView view)
      Delete the RapidView that is associated to the provided RapidView
      Parameters:
      view - RapidView representing the rapid view to delete
      Returns:
      Void or the error that occurred

    • update

      @Transactional ServiceResult update(RapidView view)
      Update a RapidView associated to the id of the provided RapidView after first checking that it is valid.
      Parameters:
      view - RapidView containing the id and updates (over-writing existing values) of the target RapidView
      Returns:
      Void or the error that occurred

    • copy

      @Transactional ServiceOutcome<RapidView> copy(RapidView sourceRapidView, RapidView destinationRapidView, com.atlassian.jira.user.ApplicationUser creator)
      Copy the contents of one RapidView into another
      Parameters:
      creator - the user creating this copy
      sourceRapidView - the RapidView to copy
      destinationRapidView - the destination RapidView
      Returns:
      a copied RapidView

    • getFirst

      ServiceOutcome<RapidView> getFirst(RapidViewManager.RapidViewPermissionCheck permissionCheck)
      Return the first RapidView found after iterating over the entire list.
      Parameters:
      permissionCheck - a permission check to perform to determine whether a RapidBoard should be included
      Returns:
      a RapidView that is the first visible RapidView based on the permissionCheck

    • getAll

      ServiceOutcome<List<RapidView>> getAll(RapidViewManager.RapidViewPermissionCheck permissionCheck)
      Get a list of all RapidViews that are visible for a permissionCheck
      Parameters:
      permissionCheck - a permissionCheck to perform to determine if a RapidView is visible
      Returns:
      a list of all visible rapid views

    • getAll

      ServiceOutcome<List<RapidView>> getAll()
      Get a list of all RapidViews that exist, regardless of any security considerations.
      Returns:
      a list of all rapid views

    • find

      ServiceOutcome<Iterable<RapidView>> find(@Nullable RapidViewSimpleQuery rapidViewQuery)
      Get a list of all RapidViews which fulfil query constraints.
      Parameters:
      rapidViewQuery - which contains expectation to rapidViews.
      Returns:
      a filtered iterable of rapidView.

    • get

      ServiceOutcome<RapidView> get(Long id)
      Get a RapidBoard from cache directly
      Parameters:
      id - the id of the RapidBoard
      Returns:
      a Option containing the rapid board which may or may not contain a result

    • findByFilterId

      List<RapidView> findByFilterId(long filterId)
      Get a list of all RapidView objects that are configured to use the filter with the given id.
      Parameters:
      filterId - id of the filter
      Returns:
      A list of all RapidView objects that are configured to use the filter with the given id.