org.squashtest.csp.tm.internal.service.customField
Class CustomFieldBindingModificationServiceImpl

java.lang.Object
  org.squashtest.csp.tm.internal.service.customField.CustomFieldBindingModificationServiceImpl

All Implemented Interfaces:

CustomFieldBindingFinderService, CustomFieldBindingModificationService

@Transactional
@Service(value="squashtest.tm.service.CustomFieldBindingService")
public class CustomFieldBindingModificationServiceImpl
extends Object
implements CustomFieldBindingModificationService

Constructor Summary

CustomFieldBindingModificationServiceImpl()

Method Summary

void	addNewCustomFieldBinding(long projectId, BindableEntity entity, long customFieldId, CustomFieldBinding newBinding) Will attach a CustomField to a Project.
void	copyCustomFieldsSettingsFromTemplate(Project newProject, ProjectTemplate projectTemplate) Will copy the custom field bindings of the template and apply them to the project.
List<CustomField>	findAvailableCustomFields() returns all the existing custom fields.
List<CustomField>	findAvailableCustomFields(long projectId, BindableEntity entity) same as CustomFieldBindingFinderService.findAvailableCustomFields(), restricted to the given project and bindable entity.
List<CustomFieldBinding>	findCustomFieldsForBoundEntity(BoundEntity boundEntity) returns all the custom field bindinds associated to that entity wrt its project and BindableEntity type
List<CustomFieldBinding>	findCustomFieldsForGenericProject(long projectId) returns all the custom field bindings associated to a GenericProject.
List<CustomFieldBinding>	findCustomFieldsForProjectAndEntity(long projectId, BindableEntity entity) returns all the custom field bindings associated to a project for a given entity type
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<CustomFieldBinding>>	findCustomFieldsForProjectAndEntity(long projectId, BindableEntity entity, org.squashtest.tm.core.foundation.collection.Paging paging) returns all the custom field bindings associated to a project for a given entity type (paged version)
void	moveCustomFieldbindings(List<Long> bindingIds, int newIndex) Given a list of CustomFieldBindings, will reorder them with respect to their project and bound entity.
void	removeCustomFieldBindings(List<Long> bindingIds) removes a batch of custom field bindings using their ids.
void	removeCustomFieldBindings(Long projectId) removes all the custom field bindings defined for a project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomFieldBindingModificationServiceImpl

public CustomFieldBindingModificationServiceImpl()

Method Detail

findAvailableCustomFields

public List<CustomField> findAvailableCustomFields()

Description copied from interface: CustomFieldBindingFinderService

returns all the existing custom fields.

Specified by:

findAvailableCustomFields in interface CustomFieldBindingFinderService

Returns:

what I just said.

findAvailableCustomFields

public List<CustomField> findAvailableCustomFields(long projectId,
                                                   BindableEntity entity)

Description copied from interface: CustomFieldBindingFinderService

same as CustomFieldBindingFinderService.findAvailableCustomFields(), restricted to the given project and bindable entity. The only returned fields are those who aren't already mapped for that project and entity.

Specified by:

findAvailableCustomFields in interface CustomFieldBindingFinderService

Returns:

findCustomFieldsForGenericProject

public List<CustomFieldBinding> findCustomFieldsForGenericProject(long projectId)

Description copied from interface: CustomFieldBindingFinderService

returns all the custom field bindings associated to a GenericProject.

Specified by:

findCustomFieldsForGenericProject in interface CustomFieldBindingFinderService

Returns:

findCustomFieldsForProjectAndEntity

public List<CustomFieldBinding> findCustomFieldsForProjectAndEntity(long projectId,
                                                                    BindableEntity entity)

Description copied from interface: CustomFieldBindingFinderService

returns all the custom field bindings associated to a project for a given entity type

Specified by:

findCustomFieldsForProjectAndEntity in interface CustomFieldBindingFinderService

Returns:

findCustomFieldsForBoundEntity

public List<CustomFieldBinding> findCustomFieldsForBoundEntity(BoundEntity boundEntity)

Description copied from interface: CustomFieldBindingFinderService

returns all the custom field bindinds associated to that entity wrt its project and BindableEntity type

Specified by:

findCustomFieldsForBoundEntity in interface CustomFieldBindingFinderService

Returns:

findCustomFieldsForProjectAndEntity

public org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<CustomFieldBinding>> findCustomFieldsForProjectAndEntity(long projectId,
                                                                                                                                        BindableEntity entity,
                                                                                                                                        org.squashtest.tm.core.foundation.collection.Paging paging)

Description copied from interface: CustomFieldBindingFinderService

returns all the custom field bindings associated to a project for a given entity type (paged version)

Specified by:

findCustomFieldsForProjectAndEntity in interface CustomFieldBindingFinderService

Returns:

addNewCustomFieldBinding

@PreAuthorize(value="hasRole(\'ROLE_TM_PROJECT_MANAGER\') or hasRole(\'ROLE_ADMIN\')")
public void addNewCustomFieldBinding(long projectId,
                                                  BindableEntity entity,
                                                  long customFieldId,
                                                  CustomFieldBinding newBinding)

Description copied from interface: CustomFieldBindingModificationService

Will attach a CustomField to a Project. The details and conditions of that binding is described in the CustomFieldBinding newBinding. The new binding will be inserted last.

Specified by:

addNewCustomFieldBinding in interface CustomFieldBindingModificationService

removeCustomFieldBindings

@PreAuthorize(value="hasRole(\'ROLE_TM_PROJECT_MANAGER\') or hasRole(\'ROLE_ADMIN\')")
public void removeCustomFieldBindings(List<Long> bindingIds)

Description copied from interface: CustomFieldBindingModificationService

removes a batch of custom field bindings using their ids.

Specified by:

removeCustomFieldBindings in interface CustomFieldBindingModificationService

removeCustomFieldBindings

@PreAuthorize(value="hasRole(\'ROLE_TM_PROJECT_MANAGER\') or hasRole(\'ROLE_ADMIN\')")
public void removeCustomFieldBindings(Long projectId)

Description copied from interface: CustomFieldBindingModificationService

removes all the custom field bindings defined for a project.

Specified by:

removeCustomFieldBindings in interface CustomFieldBindingModificationService

Parameters:

projectId - the id of the project

moveCustomFieldbindings

@PreAuthorize(value="hasRole(\'ROLE_TM_PROJECT_MANAGER\') or hasRole(\'ROLE_ADMIN\')")
public void moveCustomFieldbindings(List<Long> bindingIds,
                                                 int newIndex)

Description copied from interface: CustomFieldBindingModificationService

Given a list of CustomFieldBindings, will reorder them with respect to their project and bound entity. This method assumes that they all bind the same entity to the same project. If the input list mixes binding for different projects and/or entities, unexpected behavior may occur.

Specified by:

moveCustomFieldbindings in interface CustomFieldBindingModificationService

See Also:

CustomFieldBindingModificationService.copyCustomFieldsSettingsFromTemplate(Project, ProjectTemplate)

copyCustomFieldsSettingsFromTemplate

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public void copyCustomFieldsSettingsFromTemplate(Project newProject,
                                                              ProjectTemplate projectTemplate)

Description copied from interface: CustomFieldBindingModificationService

Will copy the custom field bindings of the template and apply them to the project.

Specified by:

copyCustomFieldsSettingsFromTemplate in interface CustomFieldBindingModificationService

See Also:

CustomFieldBindingModificationService.copyCustomFieldsSettingsFromTemplate(Project, ProjectTemplate)