org.squashtest.tm.service.customfield

Interface CustomFieldValueFinderService

All Known Subinterfaces:

CustomFieldValueManagerService, PrivateCustomFieldValueService

All Known Implementing Classes:

PrivateCustomFieldValueServiceImpl

public interface CustomFieldValueFinderService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areValuesEditable(long boundEntityId, org.squashtest.tm.domain.customfield.BindableEntity bindableEntity) Tells if the CF values of the given entity are editable, according to both security rules and sensible business rules.
List<org.squashtest.tm.domain.customfield.CustomFieldValue>	findAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity boundEntity) Will return the list of the custom field values associated to the specified bound entity.
List<org.squashtest.tm.domain.customfield.CustomFieldValue>	findAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> boundEntities) Same as findAllCustomFieldValues(BoundEntity), using a List of entities instead.
List<org.squashtest.tm.domain.customfield.CustomFieldValue>	findAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> boundEntities, Collection<org.squashtest.tm.domain.customfield.CustomField> restrictedToThoseCustomfields) Same as findAllCustomFieldValues(Collection), but only the values refering to one of the custom fields given as argument will be retained.
List<org.squashtest.tm.domain.customfield.CustomFieldValue>	findAllCustomFieldValues(long boundEntityId, org.squashtest.tm.domain.customfield.BindableEntity bindableEntity) Same as findAllCustomFieldValues(BoundEntity), but the properties identifying a BoundEntity are broken down into its ID and type.
List<org.squashtest.tm.domain.customfield.CustomFieldValue>	findAllForEntityAndRenderingLocation(org.squashtest.tm.domain.customfield.BoundEntity boundEntity, org.squashtest.tm.domain.customfield.RenderingLocation renderingLocation)
boolean	hasCustomFields(org.squashtest.tm.domain.customfield.BoundEntity boundEntity) Tells whether the given bound entity has custom fields or not.
boolean	hasCustomFields(Long boundEntityId, org.squashtest.tm.domain.customfield.BindableEntity bindableEntity) Same as hasCustomFields(BoundEntity), the bound entity being identified by its type and id

Method Detail

findAllCustomFieldValues

List<org.squashtest.tm.domain.customfield.CustomFieldValue> findAllCustomFieldValues(org.squashtest.tm.domain.customfield.BoundEntity boundEntity)

Will return the list of the custom field values associated to the specified bound entity. The authenticated use must be administrator or have read permission on that entity.

Parameters:

entityId -

entityType -

Returns:

findAllCustomFieldValues

List<org.squashtest.tm.domain.customfield.CustomFieldValue> findAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> boundEntities)

Same as findAllCustomFieldValues(BoundEntity), using a List of entities instead. This method is pure convenience, to fetch custom fields in bulk (and soften the db queries overhead). The order of the result is arbitrary.

Parameters:

boundEntity -

Returns:

findAllCustomFieldValues

List<org.squashtest.tm.domain.customfield.CustomFieldValue> findAllCustomFieldValues(Collection<? extends org.squashtest.tm.domain.customfield.BoundEntity> boundEntities,
                                                                                   Collection<org.squashtest.tm.domain.customfield.CustomField> restrictedToThoseCustomfields)

Same as findAllCustomFieldValues(Collection), but only the values refering to one of the custom fields given as argument will be retained.

Parameters:

boundEntities -

restrictedToThoseCustomfields -

Returns:

hasCustomFields

boolean hasCustomFields(org.squashtest.tm.domain.customfield.BoundEntity boundEntity)

Tells whether the given bound entity has custom fields or not.

Parameters:

boundEntity -

Returns:

hasCustomFields

boolean hasCustomFields(Long boundEntityId,
                      org.squashtest.tm.domain.customfield.BindableEntity bindableEntity)

Same as hasCustomFields(BoundEntity), the bound entity being identified by its type and id

Parameters:

boundEntityId -

bindableEntity -

Returns:

findAllCustomFieldValues

List<org.squashtest.tm.domain.customfield.CustomFieldValue> findAllCustomFieldValues(long boundEntityId,
                                                                                   org.squashtest.tm.domain.customfield.BindableEntity bindableEntity)

Same as findAllCustomFieldValues(BoundEntity), but the properties identifying a BoundEntity are broken down into its ID and type.

Parameters:

boundEntityId -

bindableEntity -

Returns:

areValuesEditable

boolean areValuesEditable(long boundEntityId,
                        org.squashtest.tm.domain.customfield.BindableEntity bindableEntity)

Tells if the CF values of the given entity are editable, according to both security rules and sensible business rules.

Parameters:

boundEntityId -

bindableEntity -

Returns:

findAllForEntityAndRenderingLocation

List<org.squashtest.tm.domain.customfield.CustomFieldValue> findAllForEntityAndRenderingLocation(org.squashtest.tm.domain.customfield.BoundEntity boundEntity,
                                                                                               org.squashtest.tm.domain.customfield.RenderingLocation renderingLocation)