To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Configuration for how the record-editing UI presents products within a named product category. XStream-serialised as a category element inside controllers.xml, and looked up by category name through Queries.findProductCategoryContent or CatalogManager.findProductCategoryContent. Controls the help text shown on the editor, whether unlisted custom fields are hidden, and the per-field configuration for any custom fields on the category.
Group: Queries
Properties
| Property | Returns | Description |
|---|---|---|
| fieldConfigs | List<ProductCategoryFieldConfig> | The per-field configuration for this category's custom fields. |
| helpText | String | Help text displayed to the user on the category's product record-editing page. |
| name | String | The name of the product category this configuration applies to, used to look it up via findProductCategoryContent. Never null. |
| showOnlyKnownFields | boolean | Whether the record-editing UI should show only the custom fields listed in getFieldConfigs, hiding any other custom field found on the category. |
Methods
findField(String name)
Returns: ProductCategoryFieldConfig
Finds the field configuration for a named custom field on this category, by exact name match.
| Parameter | Description |
|---|---|
name | the name (identifier) of the field to find, such as "code" or "my-custom-field" |
getName()
Returns: String
The name of the product category this configuration applies to, used to look it up via findProductCategoryContent. Never null.
getHelpText()
Returns: String
Help text displayed to the user on the category's product record-editing page.
isShowOnlyKnownFields()
Returns: boolean
Whether the record-editing UI should show only the custom fields listed in getFieldConfigs, hiding any other custom field found on the category.
getFieldConfigs()
Returns: List<ProductCategoryFieldConfig>
The per-field configuration for this category's custom fields.
© 2025 Kademi Ltd