Package org.broadleafcommerce.common.presentation

Annotation Interface AdminPresentationCollection

@Retention(RUNTIME) @Target(FIELD) public @interface AdminPresentationCollection
This annotation is used to describe a simple persistent collection for use by the admin tool.
Author:
Jeff Fischer

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    addFriendlyName
    Optional - field name will be used if not specified
    AddMethodType
    addType
    Optional - only required if you want to lookup an item for this association, rather than creating a new instance of the target item.
    String
    currencyCodeField
    Optional - If you have FieldType set to SupportedFieldType.MONEY, * then you can specify a money currency property field.
    String[]
    customCriteria
    Optional - only required if you need to specially handle CRUD operations for this specific collection on the server
    boolean
    excluded
    Optional - fields are not excluded by default
    String
    friendlyName
    Optional - field name will be used if not specified
    String
    group
    Used to map the collection to a group defined in AdminPresentationClass using AdminGroupPresentation.
    boolean
    lazyFetch
    Optional - fields are eagerly fetched by default
    boolean
    manualFetch
    Optional - fields are manually fetched by default
    String
    manyToField
    Optional - only required in the absence of a "mappedBy" property on the JPA annotation
    AdminPresentationOperationTypes
    operationTypes
    Optional - only required if a special operation type is required for a CRUD operation.
    int
    order
    Optional - only required if you want to specify ordering for this field
    boolean
    readOnly
    Optional - only required if you want to make the field immutable
    String
    securityLevel
    Optional - only required if you wish to apply security to this field
    String
    selectizeVisibleField
    Optional - only required when using the "SELECTIZE_LOOKUP" addType for a collection
    FieldValueConfiguration[]
    showIfFieldEquals
    Optional - only required if you want hide the field based on the supplied field's value
    String
    showIfProperty
    Optional - propertyName , only required if you want hide the field based on this property's value
    boolean
    sortAscending
    Optional - only required if the sort order should be descending
    String
    sortProperty
    Optional - only required if the collection a field used for sorting
    String
    tab
    Deprecated.
    int
    tabOrder
    Deprecated.
    boolean
    useServerSideInspectionCache
    Optional - only required if you want to make the field ignore caching

  • Element Details

    • friendlyName

      String friendlyName

      Optional - field name will be used if not specified

      The friendly name to present to a user for this field in a GUI. If supporting i18N, the friendly name may be a key to retrieve a localized friendly name using the GWT support for i18N.

      Note: do not use the "/" character (or encode via i18N resource).

      Returns:
      the friendly name
      Default:
      ""

    • addFriendlyName

      String addFriendlyName

      Optional - field name will be used if not specified

      The add friendly name to present to a user for this field in the add GUI. If supporting i18N, the friendly name may be a key to retrieve a localized friendly name using the GWT support for i18N.

      Returns:
      the add friendly name
      Default:
      ""

    • securityLevel

      String securityLevel

      Optional - only required if you wish to apply security to this field

      If a security level is specified, it is registered with the SecurityManager. The SecurityManager checks the permission of the current user to determine if this field should be disabled based on the specified level.

      Returns:
      the security level
      Default:
      ""

    • excluded

      boolean excluded

      Optional - fields are not excluded by default

      Specify if this field should be excluded from inclusion in the admin presentation layer

      Returns:
      whether or not the field should be excluded
      Default:
      false

    • readOnly

      boolean readOnly

      Optional - only required if you want to make the field immutable

      Explicityly specify whether or not this field is mutable.

      Returns:
      whether or not this field is read only
      Default:
      false

    • 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

    • addType

      AddMethodType addType

      Optional - only required if you want to lookup an item for this association, rather than creating a new instance of the target item. Note - if the type is changed to LOOKUP, and you do not wish for the lookup entity to be deleted during an admin collection item removal operation, you should specify a removeType of OperationType.NONDESTRUCTIVEREMOVE in operationTypes() param for this annotation.

      If the type is set to LOOKUP_FOR_UPDATE, the system will trigger an update call on the target entity instead of an add. This is typically used when the target entity also has a to-one lookup to this field.

      Define whether or not added items for this collection are acquired via search or construction.

      Returns:
      the item is acquired via lookup or construction
      Default:
      PERSIST

    • manyToField

      String manyToField

      Optional - only required in the absence of a "mappedBy" property on the JPA annotation

      For the target entity of this collection, specify the field name that refers back to the parent entity.

      For collection definitions that use the "mappedBy" property of the @OneToMany and @ManyToMany annotations, this value can be safely ignored as the system will be able to infer the proper value from this.

      Returns:
      the parent entity referring field name
      Default:
      ""

    • order

      int order

      Optional - only required if you want to specify ordering for this field

      The order in which this field will appear in a GUI relative to other collections from the same class

      Returns:
      the display order
      Default:
      99999

    • tab

      @Deprecated String tab
      Deprecated.
      Optional - only required if you want the field to appear under a different tab

      Specify a GUI tab for this field

      Returns:
      the tab for this field
      Default:
      "General"

    • tabOrder

      @Deprecated int tabOrder
      Deprecated.
      Optional - only required if you want to order the appearance of the tabs in the UI

      Specify an order for this tab. Tabs will be sorted int he resulting form in ascending order based on this parameter.

      The default tab will render with an order of 99999.

      Returns:
      the order for this tab
      Default:
      99999

    • 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 CRUD operations on this collection. These criteria values can be detected in a custom persistence handler (@CustomPersistenceHandler) in order to engage special handling through custom server side code for this collection.

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

    • operationTypes

      AdminPresentationOperationTypes operationTypes

      Optional - only required if a special operation type is required for a CRUD operation. This setting is not normally changed and is an advanced setting

      The operation type for a CRUD operation

      Returns:
      the operation type
      Default:
      @org.broadleafcommerce.common.presentation.AdminPresentationOperationTypes(addType=BASIC, fetchType=BASIC, inspectType=BASIC, removeType=BASIC, updateType=BASIC)

    • showIfProperty

      String showIfProperty

      Optional - propertyName , only required if you want hide the field based on this property's value

      If the property is defined and found to be set to false, in the AppConfiguraionService, then this field will be excluded in the admin presentation layer

      Returns:
      name of the property
      Default:
      ""

    • showIfFieldEquals

      FieldValueConfiguration[] showIfFieldEquals

      Optional - only required if you want hide the field based on the supplied field's value

      If the property is defined and found to be equal to one of the values provided then this field will be excluded in the admin presentation layer

      Returns:
      configuration of the field values
      Default:
      {}

    • currencyCodeField

      String currencyCodeField
      Optional - If you have FieldType set to SupportedFieldType.MONEY, * then you can specify a money currency property field.
      Returns:
      the currency property field
      Default:
      ""

    • sortProperty

      String sortProperty

      Optional - only required if the collection a field used for sorting

      Enables the reorder functionality in list grids.
      Returns:
      the sort field in the target entity
      Default:
      ""

    • sortAscending

      boolean sortAscending

      Optional - only required if the sort order should be descending

      This is the sort direction for the targets

      Returns:
      the sort direction
      Default:
      true

    • lazyFetch

      boolean lazyFetch

      Optional - fields are eagerly fetched by default

      Specify true if this field should be lazily fetched

      Returns:
      whether or not the field should be fetched
      Default:
      true

    • manualFetch

      boolean manualFetch

      Optional - fields are manually fetched by default

      Specify true if this field should be fetched manually

      Returns:
      whether or not the field should be fetched manually
      Default:
      false

    • group

      String group
      Used to map the collection to a group defined in AdminPresentationClass using AdminGroupPresentation.

      If the group cannot be found in AdminPresentationClass, then the tab specified in AdminPresentationCollection is used to map the collection to a tab defined in AdminPresentationClass using AdminTabPresentation. If the tab cannot be found, then the collection will be placed in a tab created using the information specified in AdminPresentationCollection.

      Optional - only required if you want the field to appear under a specific group

      Specify a GUI group for this collection

      Returns:
      the group for this collection
      Default:
      ""

    • selectizeVisibleField

      String selectizeVisibleField

      Optional - only required when using the "SELECTIZE_LOOKUP" addType for a collection

      Field visible in the selectize collection UI in the admin tool. Fields are referenced relative to the the target entity. For example, in CrossSaleProductImpl, to show the product name field, the selectizeVisibleField value would be : "name"

      Returns:
      Field visible in the selectize collection UI in the admin tool
      Default:
      ""