org.squashtest.tm.service.internal.customfield

Interface PrivateCustomFieldValueService

All Superinterfaces:

CustomFieldValueFinderService, CustomFieldValueManagerService

All Known Implementing Classes:

PrivateCustomFieldValueServiceImpl

public interface PrivateCustomFieldValueService
extends CustomFieldValueManagerService

That interface is called so because it should remain private to this bundle. The reason is that the methods will not be secured.

Author:

bsiri

Method Summary

Methods

Modifier and Type	Method and Description
void	cascadeCustomFieldValuesCreation(org.squashtest.tm.domain.customfield.CustomFieldBinding binding) Will create a custom field value for all the entities affected by the given binding
void	cascadeCustomFieldValuesDeletion(org.squashtest.tm.domain.customfield.CustomFieldBinding binding) Will remove the custom field values corresponding to the given binding
void	cascadeCustomFieldValuesDeletion(List<Long> customFieldBindingIds) Will remove the custom field values corresponding to the bindings, given their ids.
void	copyCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity source, org.squashtest.tm.domain.customfield.BoundEntity recipient) Will copy the custom field values from an entity to another entity, creating them in the process
void	copyCustomFieldValues(Map<Long,org.squashtest.tm.domain.customfield.BoundEntity> copiedEntityBySource, org.squashtest.tm.domain.customfield.BindableEntity bindableEntityType) *Will copy the custom field values from entities to others, creating them in the process
void	copyCustomFieldValuesContent(org.squashtest.tm.domain.customfield.BoundEntity source, org.squashtest.tm.domain.customfield.BoundEntity recipient) Will copy the custom field values from an entity to another entity.
void	createAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity, org.squashtest.tm.domain.project.Project project) Will create all the custom field values for one entity.
void	createAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> entities, org.squashtest.tm.domain.project.Project project) batched version of createAllCustomFieldValues(BoundEntity, Project).
void	deleteAllCustomFieldValues(org.squashtest.tm.domain.customfield.BindableEntity entityType, List<Long> entityIds) Will delete all the custom field values for multiple BoundEntities
void	deleteAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity) will delete all the custom field vales for one entity
void	migrateCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity) Will ensure that the custom field values of an entity are consistent with the custom fields bound to the project it belongs to, at the time when the method is invoked.
void	migrateCustomFieldValues(Collection<org.squashtest.tm.domain.customfield.BoundEntity> entities) Same as migrateCustomFieldValues(BoundEntity), batched version.

Methods inherited from interface org.squashtest.tm.service.customfield.CustomFieldValueManagerService

changeValue

Methods inherited from interface org.squashtest.tm.service.customfield.CustomFieldValueFinderService

areValuesEditable, findAllCustomFieldValues, findAllCustomFieldValues, findAllCustomFieldValues, findAllCustomFieldValues, findAllForEntityAndRenderingLocation, hasCustomFields, hasCustomFields

Method Detail

cascadeCustomFieldValuesCreation

void cascadeCustomFieldValuesCreation(org.squashtest.tm.domain.customfield.CustomFieldBinding binding)

Will create a custom field value for all the entities affected by the given binding

Parameters:

binding -

cascadeCustomFieldValuesDeletion

void cascadeCustomFieldValuesDeletion(org.squashtest.tm.domain.customfield.CustomFieldBinding binding)

Will remove the custom field values corresponding to the given binding

Parameters:

binding -

cascadeCustomFieldValuesDeletion

void cascadeCustomFieldValuesDeletion(List<Long> customFieldBindingIds)

Will remove the custom field values corresponding to the bindings, given their ids.

Parameters:

binding -

createAllCustomFieldValues

void createAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity,
                              org.squashtest.tm.domain.project.Project project)

Will create all the custom field values for one entity.

Parameters:

entity -

project - . If null, the project of the given entity will be used.

createAllCustomFieldValues

void createAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> entities,
                              org.squashtest.tm.domain.project.Project project)

batched version of createAllCustomFieldValues(BoundEntity, Project). The entities are assumed to be all of the same concrete class and of the same project.

Parameters:

entities -

project -

deleteAllCustomFieldValues

void deleteAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity)

will delete all the custom field vales for one entity

Parameters:

entity -

deleteAllCustomFieldValues

void deleteAllCustomFieldValues(org.squashtest.tm.domain.customfield.BindableEntity entityType,
                              List<Long> entityIds)

Will delete all the custom field values for multiple BoundEntities

Parameters:

entityType - the BindableEntity that all of the BoundEntity must share

entityIds - the ids of those BoundEntities

copyCustomFieldValues

void copyCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity source,
                         org.squashtest.tm.domain.customfield.BoundEntity recipient)

Will copy the custom field values from an entity to another entity, creating them in the process

Parameters:

source - : the BoundEntity from witch the cuf are copied

recipient - : the BoundEntity

copyCustomFieldValues

void copyCustomFieldValues(Map<Long,org.squashtest.tm.domain.customfield.BoundEntity> copiedEntityBySource,
                         org.squashtest.tm.domain.customfield.BindableEntity bindableEntityType)

*Will copy the custom field values from entities to others, creating them in the process

Parameters:

copiedEntityBySource - : a Map with

• key : the source BoundEntity id
• value : the copy BoundEntity to add the cufs to

bindableEntityType - : the BindableEntity type for all BoundEntity in the "copiedEntityBySource" map.

copyCustomFieldValuesContent

void copyCustomFieldValuesContent(org.squashtest.tm.domain.customfield.BoundEntity source,
                                org.squashtest.tm.domain.customfield.BoundEntity recipient)

Will copy the custom field values from an entity to another entity. It assumes that the custom field values already exists for both, and will simply invoke CustomFieldValue.setValue(String) from one to the other.

Parameters:

source -

dest -

migrateCustomFieldValues

void migrateCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity entity)

Will ensure that the custom field values of an entity are consistent with the custom fields bound to the project it belongs to, at the time when the method is invoked. Indeed inconsistencies arise when an entity is moved from one project to another. This method will fix these inconsistencies in three steps :

1. creating the custom field values corresponding to the bindings of the current project,
2. copy the custom field values from the former project into those of the new project if any matching values are found,
3. delete the custom field values from the former project.

Parameters:

entity -

migrateCustomFieldValues

void migrateCustomFieldValues(Collection<org.squashtest.tm.domain.customfield.BoundEntity> entities)

Same as migrateCustomFieldValues(BoundEntity), batched version.

Parameters:

entities -