com.broadleafcommerce.customfield.dao

Interface CustomFieldDao

All Known Implementing Classes:

CustomFieldDaoImpl

public interface CustomFieldDao

Data Access Object for retrieving information regarding custom fields.

Author:

Jeff Fischer

See Also:

CustomField

Method Summary

Modifier and Type	Method and Description
List<AllowedEnumValue>	readAllowedValuesForCustomField(CustomField customField) Returns the allowedEnumValues for the given custom field
Boolean	readIsMultiValueByPropertyName(String propertyName, String targetEntityName) Returns whether the associated CustomField is marked as allowMultiValueSelect
List<CustomField>	retrieveAll() Returns all known CustomFields
List<CustomField>	retrieveByFriendlyName(String friendlyName, String targetEntityName) Get a list of custom fields for the given friendly name and target entity
CustomField	retrieveById(Long id) Get the custom field via its primary key value
List<CustomField>	retrieveByName(String attributeName, String friendlyName, String targetEntityName) Get a list of custom fields via the attribute name.
List<CustomField>	retrieveByPropertyName(String propertyName, String targetEntityName) Get a list of custom fields for the given property name and target entity
List<CustomField>	retrieveByTargetEntityName(String targetEntityName) Get a list of custom fields via the target entity name.
CustomField	save(CustomField customField) Persists the given customField and returns the persisted version

Method Detail

retrieveById

CustomField retrieveById(Long id)

Get the custom field via its primary key value

Parameters:

id - the primary key value

Returns:

the custom field instance

retrieveByTargetEntityName

List<CustomField> retrieveByTargetEntityName(String targetEntityName)

Get a list of custom fields via the target entity name. The target entity is the fully qualified class name of the entity type that contains the attribute map for list of returned custom fields.

Parameters:

targetEntityName - the entity type that contains the attribute map for the custom fields.

Returns:

the custom field instances that are related to the target entity type.

retrieveByName

List<CustomField> retrieveByName(String attributeName,
                                 String friendlyName,
                                 String targetEntityName)

Get a list of custom fields via the attribute name.

Parameters:

attributeName - the attribute name for a custom field

friendlyName - the user visible name for the field

targetEntityName - the entity type that contains the attribute map for the custom fields.

Returns:

the custom field instances

retrieveByFriendlyName

List<CustomField> retrieveByFriendlyName(String friendlyName,
                                         String targetEntityName)

Get a list of custom fields for the given friendly name and target entity

Parameters:

friendlyName - the friendly name of the custom field to retrieve

targetEntityName - the target entity for the custom field to retrieve

Returns:

retrieveByPropertyName

List<CustomField> retrieveByPropertyName(String propertyName,
                                         String targetEntityName)

Get a list of custom fields for the given property name and target entity

Parameters:

propertyName - the property name of the custom field to retreive

targetEntityName - the target entity for the custom field to retrieve

Returns:

retrieveAll

List<CustomField> retrieveAll()

Returns all known CustomFields

Returns:

all known CustomFields

save

CustomField save(CustomField customField)

Persists the given customField and returns the persisted version

Parameters:

customField -

Returns:

the persisted version

readAllowedValuesForCustomField

List<AllowedEnumValue> readAllowedValuesForCustomField(CustomField customField)

Returns the allowedEnumValues for the given custom field

Parameters:

customField -

Returns:

readIsMultiValueByPropertyName

Boolean readIsMultiValueByPropertyName(String propertyName,
                                       String targetEntityName)

Returns whether the associated CustomField is marked as allowMultiValueSelect

Parameters:

propertyName -

targetEntityName -

Returns: