org.squashtest.tm.service.customfield

Interface CustomFieldBindingFinderService

All Known Subinterfaces:

CustomFieldBindingModificationService

All Known Implementing Classes:

CustomFieldBindingModificationServiceImpl

public interface CustomFieldBindingFinderService

An interface for services around CustomField. This is a 'finder' service : those methods are meant to find data, not to modify them. The methods in this service need not to be secured.

Author:

bsiri

Method Summary

Methods

Modifier and Type	Method and Description
List<org.squashtest.tm.domain.customfield.CustomField>	findAvailableCustomFields() returns all the existing custom fields.
List<org.squashtest.tm.domain.customfield.CustomField>	findAvailableCustomFields(long projectId, org.squashtest.tm.domain.customfield.BindableEntity entity) same as findAvailableCustomFields(), restricted to the given project and bindable entity.
List<org.squashtest.tm.domain.customfield.CustomField>	findBoundCustomFields(long projectId, org.squashtest.tm.domain.customfield.BindableEntity entity) Returns the complementary of findAvailableCustomFields(long, BindableEntity)
List<org.squashtest.tm.domain.customfield.CustomFieldBinding>	findCustomFieldsForBoundEntity(org.squashtest.tm.domain.customfield.BoundEntity boundEntity) returns all the custom field bindinds associated to that entity wrt its project and BindableEntity type
List<org.squashtest.tm.domain.customfield.CustomFieldBinding>	findCustomFieldsForGenericProject(long projectId) returns all the custom field bindings associated to a GenericProject.
List<org.squashtest.tm.domain.customfield.CustomFieldBinding>	findCustomFieldsForProjectAndEntity(long projectId, org.squashtest.tm.domain.customfield.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<org.squashtest.tm.domain.customfield.CustomFieldBinding>>	findCustomFieldsForProjectAndEntity(long projectId, org.squashtest.tm.domain.customfield.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)

Method Detail

findAvailableCustomFields

List<org.squashtest.tm.domain.customfield.CustomField> findAvailableCustomFields()

returns all the existing custom fields.

Returns:

what I just said.

findAvailableCustomFields

List<org.squashtest.tm.domain.customfield.CustomField> findAvailableCustomFields(long projectId,
                                                                               org.squashtest.tm.domain.customfield.BindableEntity entity)

same as 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.

Parameters:

projectId -

entity -

Returns:

findBoundCustomFields

List<org.squashtest.tm.domain.customfield.CustomField> findBoundCustomFields(long projectId,
                                                                           org.squashtest.tm.domain.customfield.BindableEntity entity)

Returns the complementary of findAvailableCustomFields(long, BindableEntity)

Parameters:

projectId -

entity -

Returns:

findCustomFieldsForGenericProject

List<org.squashtest.tm.domain.customfield.CustomFieldBinding> findCustomFieldsForGenericProject(long projectId)

returns all the custom field bindings associated to a GenericProject.

Parameters:

projectId -

Returns:

findCustomFieldsForProjectAndEntity

List<org.squashtest.tm.domain.customfield.CustomFieldBinding> findCustomFieldsForProjectAndEntity(long projectId,
                                                                                                org.squashtest.tm.domain.customfield.BindableEntity entity)

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

Parameters:

projectId -

Returns:

findCustomFieldsForBoundEntity

List<org.squashtest.tm.domain.customfield.CustomFieldBinding> findCustomFieldsForBoundEntity(org.squashtest.tm.domain.customfield.BoundEntity boundEntity)

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

Parameters:

boundEntity -

Returns:

findCustomFieldsForProjectAndEntity

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.customfield.CustomFieldBinding>> findCustomFieldsForProjectAndEntity(long projectId,
                                                                                                                                                                    org.squashtest.tm.domain.customfield.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)

Parameters:

projectId -

Returns: