Package org.broadleafcommerce.common.presentation

Annotation Interface AdminPresentationToOneLookup

@Retention(RUNTIME) @Target(FIELD) public @interface AdminPresentationToOneLookup
Author:
Jeff Fischer

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    customCriteria
    Optional - only required if you need to specially handle crud operations for this specific collection on the server
    boolean
    enableTypeaheadLookup
    Optional - by setting this value to true, the admin will utilize a typeahead based lookup to search for the associated entity.
    boolean
    forcePopulateChildProperties
    Optional - by setting this value to true, the admin will identify the properties that are inside the target of this to-one field.
    String
    lookupDisplayProperty
    Optional - only required if the display property is other than "name"
    LookupType
    lookupType
    Optional - only required if you want to configure the lookup to be driven by a prepopulated dropdown instead of the standard lookup type, which is modal based.
    boolean
    useServerSideInspectionCache
    Optional - only required if you want to make the field ignore caching

  • Element Details

    • lookupDisplayProperty

      String lookupDisplayProperty

      Optional - only required if the display property is other than "name"

      Specify the property on a lookup class that should be used as the value to display to the user in a form in the admin tool UI

      Returns:
      the property on the lookup class containing the displayable value
      Default:
      ""

    • customCriteria

      String[] customCriteria

      Optional - only required if you need to specially handle crud operations for this specific collection on the server

      Custom string values that will be passed to the server during Read and Inspect operations on the entity lookup. This allows for the creation of a custom persistence handler to handle both inspect and fetch phase operations. Presumably, one could use this to somehow filter the list of records shown when the user interacts with the lookup widget in the admin UI.

      Returns:
      the custom string array to pass to the server during CRUD operations
      Default:
      {}

    • useServerSideInspectionCache

      boolean useServerSideInspectionCache

      Optional - only required if you want to make the field ignore caching

      Explicitly specify whether or not this field will use server-side caching during inspection

      Returns:
      whether or not this field uses caching
      Default:
      true

    • lookupType

      LookupType lookupType

      Optional - only required if you want to configure the lookup to be driven by a prepopulated dropdown instead of the standard lookup type, which is modal based.

      Define whether or not the lookup type for this field should be handled through a modal or through a dropdown

      Returns:
      the item is looked up via a modal or dropdown
      Default:
      STANDARD

    • forcePopulateChildProperties

      boolean forcePopulateChildProperties

      Optional - by setting this value to true, the admin will identify the properties that are inside the target of this to-one field.

      Typically, this is done if you want to expose a certain field as an AdminPresentationToOneLookup but also allow filtering on a property that resides inside of the target of this lookup.

      Returns:
      whether or not to force population of the child properties
      Default:
      false

    • enableTypeaheadLookup

      boolean enableTypeaheadLookup

      Optional - by setting this value to true, the admin will utilize a typeahead based lookup to search for the associated entity. When the value is set to false, the admin will utilize a model that can be used to search to the server for the associated entity.

      Returns:
      whether or not to enable the typeahead lookup feature for this field
      Default:
      false