com.atlassian.greenhopper.service.rapid.view.detailview
Interface DetailViewFieldConfigurationService

All Known Implementing Classes:

DetailViewFieldConfigurationServiceImpl

public interface DetailViewFieldConfigurationService

Services to configure DetailViewField entries for a RapidView. To retrieve the fields to use at display time (not configuration time), see DetailViewFieldService.

See Also:

DetailViewFieldConfig, DetailViewFieldService

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.
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 moveBeforeDetailViewFieldId) Move a DetailViewField to be before another one.

Method Detail

getDetailViewFields

@NotNull
ServiceOutcome<java.util.List<DetailViewFieldConfig>> getDetailViewFields(@NotNull
                                                                                  RapidView rapidView)

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.

Parameters:

rapidView - the view

Returns:

the outcome

getAvailableDetailViewCustomFields

@NotNull
ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewCustomFields()

Get the list of fields which can be configured across the system.

Returns:

the outcome

getAvailableDetailViewFields

@NotNull
ServiceOutcome<java.util.List<? extends com.atlassian.jira.issue.fields.Field>> getAvailableDetailViewFields(@NotNull
                                                                                                                     RapidView rapidView)

Get the list of fields which can be configured for this RapidView. Does not include fields which are already configured.

Returns:

the outcome

add

@NotNull
ServiceOutcome<java.util.List<DetailViewFieldConfig>> add(com.atlassian.crowd.embedded.api.User user,
                                                                  @NotNull
                                                                  RapidView rapidView,
                                                                  @NotNull
                                                                  DetailViewField detailViewField)

Add a DetailViewField object to a RapidView's configuration.

Parameters:

user - the user

rapidView - the view

detailViewField - the field to add

Returns:

the new configuration

delete

@NotNull
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.

Parameters:

user - the user performing the delete

rapidView - the view

detailViewFieldId - the ID of the row to delete

Returns:

the outcome

moveAfter

@NotNull
ServiceOutcome<java.lang.Void> moveAfter(com.atlassian.crowd.embedded.api.User user,
                                                 RapidView rapidView,
                                                 long detailViewFieldId,
                                                 java.lang.Long moveBeforeDetailViewFieldId)

Move a DetailViewField to be before another one.

Parameters:

user - the user performing the move

rapidView - the view

detailViewFieldId - the ID of the row to move

moveBeforeDetailViewFieldId - the ID of the row to move the other one after. If null it is moved to the first position

Returns:

the outcome

createDefaultRapidViewFields

@NotNull
ServiceOutcome<java.util.List<DetailViewField>> createDefaultRapidViewFields(com.atlassian.crowd.embedded.api.User user,
                                                                                     RapidView rapidView)

Initially setup the rapid view

Parameters:

user - the user

rapidView - the rapid view

Returns:

succ/fail