com.atlassian.greenhopper.service.rapid.view.detailview
Class DetailViewFieldConfigurationServiceImpl

java.lang.Object
  extended by com.atlassian.greenhopper.service.rapid.view.detailview.DetailViewFieldConfigurationServiceImpl
All Implemented Interfaces:
DetailViewFieldConfigurationService

@Service
public class DetailViewFieldConfigurationServiceImpl
extends java.lang.Object
implements DetailViewFieldConfigurationService

Implementation of DetailViewFieldConfigurationService. Currently, only CustomFields of type GenericTextCFType can be added to the detail view fields configuration.

Since:
v6.0.3

Constructor Summary
DetailViewFieldConfigurationServiceImpl()
           
 
Method Summary
 ServiceOutcome<java.util.List<DetailViewFieldConfig>> add(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, DetailViewField detailViewField)
          Add a DetailViewField object to a RapidView's configuration.
 ServiceOutcome<java.util.List<DetailViewField>> createDefaultRapidViewFields(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Initially setup the rapid view
 ServiceOutcome<java.lang.Void> delete(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.lang.Long detailViewFieldId)
          Remove a DetailViewField from a RapidView's configuration.
 ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewCustomFields()
          Get the list of fields which can be configured across the system.
 ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewFields(RapidView rapidView)
          Get the list of fields which can be configured for this RapidView.
 java.util.List<? extends com.atlassian.jira.issue.fields.Field> getAvailableSystemFieldsForDetailView()
           
 java.util.List<? extends com.atlassian.jira.issue.fields.Field> getDefaultSystemFieldsForDetailView()
           
 ServiceOutcome<java.util.List<DetailViewFieldConfig>> getDetailViewFields(RapidView rapidView)
          Get the currently configured detail view fields for this RapidView.
 ServiceOutcome<java.lang.Void> moveAfter(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, long detailViewFieldId, java.lang.Long moveToDetailViewFieldId)
          Move a DetailViewField to be before another one.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DetailViewFieldConfigurationServiceImpl

public DetailViewFieldConfigurationServiceImpl()
Method Detail

getDetailViewFields

public ServiceOutcome<java.util.List<DetailViewFieldConfig>> getDetailViewFields(@NotNull
                                                                                 RapidView rapidView)
Description copied from interface: DetailViewFieldConfigurationService
Get the currently configured detail view fields for this RapidView. This will potentially include configurations which are not valid due to fields not being available.

Specified by:
getDetailViewFields in interface DetailViewFieldConfigurationService
Parameters:
rapidView - the view
Returns:
the outcome

getAvailableDetailViewCustomFields

public ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewCustomFields()
Description copied from interface: DetailViewFieldConfigurationService
Get the list of fields which can be configured across the system.

Specified by:
getAvailableDetailViewCustomFields in interface DetailViewFieldConfigurationService
Returns:
the outcome

getAvailableDetailViewFields

public ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewFields(@NotNull
                                                                                                                    RapidView rapidView)
Description copied from interface: DetailViewFieldConfigurationService
Get the list of fields which can be configured for this RapidView. Does not include fields which are already configured.

Specified by:
getAvailableDetailViewFields in interface DetailViewFieldConfigurationService
Returns:
the outcome

getAvailableSystemFieldsForDetailView

public java.util.List<? extends com.atlassian.jira.issue.fields.Field> getAvailableSystemFieldsForDetailView()

getDefaultSystemFieldsForDetailView

public java.util.List<? extends com.atlassian.jira.issue.fields.Field> getDefaultSystemFieldsForDetailView()

add

public ServiceOutcome<java.util.List<DetailViewFieldConfig>> add(com.atlassian.crowd.embedded.api.User user,
                                                                 @NotNull
                                                                 RapidView rapidView,
                                                                 @NotNull
                                                                 DetailViewField detailViewField)
Description copied from interface: DetailViewFieldConfigurationService
Add a DetailViewField object to a RapidView's configuration.

Specified by:
add in interface DetailViewFieldConfigurationService
Parameters:
user - the user
rapidView - the view
detailViewField - the field to add
Returns:
the new configuration

delete

public ServiceOutcome<java.lang.Void> delete(com.atlassian.crowd.embedded.api.User user,
                                             RapidView rapidView,
                                             java.lang.Long detailViewFieldId)
Description copied from interface: DetailViewFieldConfigurationService
Remove a DetailViewField from a RapidView's configuration.

Specified by:
delete in interface DetailViewFieldConfigurationService
Parameters:
user - the user performing the delete
rapidView - the view
detailViewFieldId - the ID of the row to delete
Returns:
the outcome

moveAfter

public ServiceOutcome<java.lang.Void> moveAfter(com.atlassian.crowd.embedded.api.User user,
                                                RapidView rapidView,
                                                long detailViewFieldId,
                                                java.lang.Long moveToDetailViewFieldId)
Description copied from interface: DetailViewFieldConfigurationService
Move a DetailViewField to be before another one.

Specified by:
moveAfter in interface DetailViewFieldConfigurationService
Parameters:
user - the user performing the move
rapidView - the view
detailViewFieldId - the ID of the row to move
moveToDetailViewFieldId - the ID of the row to move the other one after. If null it is moved to the first position
Returns:
the outcome

createDefaultRapidViewFields

public ServiceOutcome<java.util.List<DetailViewField>> createDefaultRapidViewFields(com.atlassian.crowd.embedded.api.User user,
                                                                                    RapidView rapidView)
Description copied from interface: DetailViewFieldConfigurationService
Initially setup the rapid view

Specified by:
createDefaultRapidViewFields in interface DetailViewFieldConfigurationService
Parameters:
user - the user
rapidView - the rapid view
Returns:
succ/fail


Copyright © 2007-2014 Atlassian. All Rights Reserved.