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

Interface BasicPersistenceModuleExtensionHandler

All Superinterfaces:
org.broadleafcommerce.common.extension.ExtensionHandler
All Known Implementing Classes:
AbstractBasicPersistenceModuleExtensionHandler, DefaultBasicPersistenceModuleExtensionHandler
public interface BasicPersistenceModuleExtensionHandler extends org.broadleafcommerce.common.extension.ExtensionHandler
For internal usage. Allows extending API calls without subclassing the entity.
Author:
Jeff Fischer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_PRIORITY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.broadleafcommerce.common.extension.ExtensionResultStatusType
    rebalanceForAdd(BasicPersistenceModule basicPersistenceModule, PersistencePackage persistencePackage, Serializable instance, Map<String,FieldMetadata> mergedProperties, org.broadleafcommerce.common.extension.ExtensionResultHolder<Serializable> resultHolder)
    Handle additions of new members to a basic collection when the items are sortable
    org.broadleafcommerce.common.extension.ExtensionResultStatusType
    rebalanceForUpdate(BasicPersistenceModule basicPersistenceModule, PersistencePackage persistencePackage, Serializable instance, Map<String,FieldMetadata> mergedProperties, Object primaryKey, org.broadleafcommerce.common.extension.ExtensionResultHolder<Serializable> resultHolder)
    Handle reorder change requests from the admin for sortable basic collections

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

    getPriority, isEnabled

  • Field Details

  • Method Details

    • rebalanceForUpdate

      org.broadleafcommerce.common.extension.ExtensionResultStatusType rebalanceForUpdate(BasicPersistenceModule basicPersistenceModule, PersistencePackage persistencePackage, Serializable instance, Map<String,FieldMetadata> mergedProperties, Object primaryKey, org.broadleafcommerce.common.extension.ExtensionResultHolder<Serializable> resultHolder)
      Handle reorder change requests from the admin for sortable basic collections
      Parameters:
      basicPersistenceModule - the persistence module responsible for handling basic collection persistence operations
      persistencePackage - the data representing the change
      instance - the persisted entity
      mergedProperties - descriptive data about the entity structure
      primaryKey - the primary key value for the persisted entity
      resultHolder - container for any relevant operation results
      Returns:
      the status of execution for this handler - informs the manager on how to proceed

    • rebalanceForAdd

      org.broadleafcommerce.common.extension.ExtensionResultStatusType rebalanceForAdd(BasicPersistenceModule basicPersistenceModule, PersistencePackage persistencePackage, Serializable instance, Map<String,FieldMetadata> mergedProperties, org.broadleafcommerce.common.extension.ExtensionResultHolder<Serializable> resultHolder)
      Handle additions of new members to a basic collection when the items are sortable
      Parameters:
      basicPersistenceModule - the persistence module responsible for handling basic collection persistence operations
      persistencePackage - the data representing the change
      instance - the persisted entity
      mergedProperties - descriptive data about the entity structure
      resultHolder - container for any relevant operation results
      Returns:
      the status of execution for this handler - informs the manager on how to proceed