Package org.broadleafcommerce.openadmin.server.service.persistence.extension

Interface AdornedTargetAutoPopulateExtensionHandler

All Superinterfaces:

ExtensionHandler

public interface AdornedTargetAutoPopulateExtensionHandler
extends ExtensionHandler

Extension handler for methods present in AdminBasicEntityController.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method	Description
ExtensionResultStatusType	autoSetAdornedTargetManagedFields(FieldMetadata md, String mainClassName, String id, String collectionField, String collectionItemId, Map<String,Object> managedFields)	Provides a hook for automatically setting the values for one or more adorned target collection managed fields.
ExtensionResultStatusType	validateSubmittedAdornedTargetManagedFields(Entity entity, Serializable instance, Map<String,FieldMetadata> entityFieldMetadata, BasicFieldMetadata propertyMetadata, String propertyName, String value, ExtensionResultHolder<Boolean> validationResult)	Provide validation during persistence.

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Details

autoSetAdornedTargetManagedFields

ExtensionResultStatusType autoSetAdornedTargetManagedFields(FieldMetadata md,
 String mainClassName,
 String id,
 String collectionField,
 String collectionItemId,
 Map<String,Object> managedFields)

Provides a hook for automatically setting the values for one or more adorned target collection managed fields. This can allow, through code, partial or total completion of the form in the second tab on an adorned target add interaction. Note, a special key/value pair can be included put into the managedField map to cause the second tab to be skipped and the adorned target item add form to auto submit after completing the first tab.

Parameters:

md - the metadata describing the adorned target collection field

mainClassName - the class name of the entity that contains this adorned target field

id - the id of the containing entity

collectionField - the name of the adorned target field

collectionItemId - the id of the adorned target collection member

managedFields - the map containing the adorned target field values that should be auto populated

Returns:

the final status of the operation

validateSubmittedAdornedTargetManagedFields

ExtensionResultStatusType validateSubmittedAdornedTargetManagedFields(Entity entity,
 Serializable instance,
 Map<String,FieldMetadata> entityFieldMetadata,
 BasicFieldMetadata propertyMetadata,
 String propertyName,
 String value,
 ExtensionResultHolder<Boolean> validationResult)

Provide validation during persistence. The implementation is responsible for determining suitability based on the property information passed in.

Parameters:

entity - all the values passed from the client for persistence

instance - the entity instance that is being populated

entityFieldMetadata - the FieldMetadata for all the fields

propertyMetadata - the FieldMetadata for the property

propertyName - the name of the field

value - the value being assigned to the property

validationResult - whether or not the property passes validation

Returns:

the final status of the operation