Uses of Class
org.broadleafcommerce.openadmin.dto.ClassMetadata
Packages that use ClassMetadata
Package
Description
-
Uses of ClassMetadata in org.broadleafcommerce.admin.web.controller.entity
Methods in org.broadleafcommerce.admin.web.controller.entity with parameters of type ClassMetadataModifier and TypeMethodDescriptionAdminFieldController.constructSelectizeOptionMap
(DynamicResultSet drs, ClassMetadata cmd) AdminProductController.constructSelectizeOptionMap
(DynamicResultSet drs, ClassMetadata cmd) -
Uses of ClassMetadata in org.broadleafcommerce.admin.web.controller.extension
Methods in org.broadleafcommerce.admin.web.controller.extension with parameters of type ClassMetadataModifier and TypeMethodDescriptionTypedEntityBasicEntityExtensionHandler.modifyPreAddEntityForm
(EntityForm entityForm, ClassMetadata cmd, Map<String, String> pathVars) This allows us to set the Type on the entityForm before the entity is first persisted. -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.dto
Methods in org.broadleafcommerce.openadmin.dto that return ClassMetadataModifier and TypeMethodDescriptionDynamicResultSet.getClassMetaData()
ParentRecordStructure.getParentMetadata()
Methods in org.broadleafcommerce.openadmin.dto with parameters of type ClassMetadataModifier and TypeMethodDescriptionvoid
DynamicResultSet.setClassMetaData
(ClassMetadata classMetaData) void
ParentRecordStructure.setParentMetadata
(ClassMetadata parentMetadata) Constructors in org.broadleafcommerce.openadmin.dto with parameters of type ClassMetadataModifierConstructorDescriptionDynamicResultSet
(ClassMetadata classMetaData) DynamicResultSet
(ClassMetadata classMetaData, Entity[] records, Integer totalRecords) ParentRecordStructure
(Entity parentRecord, ClassMetadata parentMetadata) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.dao
Methods in org.broadleafcommerce.openadmin.server.dao with parameters of type ClassMetadataModifier and TypeMethodDescriptionvoid
Metadata.buildAdditionalTabAndGroupMetadataFromCmdProperties
(ClassMetadata cmd, Map<String, TabMetadata> metadata) DynamicEntityDao.getTabAndGroupMetadata
(Class<?>[] clazz, ClassMetadata cmd) DynamicEntityDaoImpl.getTabAndGroupMetadata
(Class<?>[] entities, ClassMetadata cmd) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.dao.provider.metadata
Methods in org.broadleafcommerce.openadmin.server.dao.provider.metadata with parameters of type ClassMetadataModifier and TypeMethodDescriptionBasicEntityMetadataProvider.addTabAndGroupMetadataFromCmdProperties
(ClassMetadata cmd, Map<String, TabMetadata> metadata) EntityMetadataProvider.addTabAndGroupMetadataFromCmdProperties
(ClassMetadata cmd, Map<String, TabMetadata> metadata) EntityMetadataProviderAdapter.addTabAndGroupMetadataFromCmdProperties
(ClassMetadata cmd, Map<String, TabMetadata> metadata) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.security.service
Methods in org.broadleafcommerce.openadmin.server.security.service with parameters of type ClassMetadataModifier and TypeMethodDescriptionboolean
AbstractRowLevelSecurityProvider.canAdd
(AdminUser currentUser, String sectionClassName, ClassMetadata cmd) boolean
RowLevelSecurityProvider.canAdd
(AdminUser currentUser, String sectionClassname, ClassMetadata cmd) Hook to determine if the given entity can be added by a user.boolean
RowLevelSecurityServiceImpl.canAdd
(AdminUser currentUser, String sectionClassName, ClassMetadata cmd) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.service
Methods in org.broadleafcommerce.openadmin.server.service with parameters of type ClassMetadataModifier and TypeMethodDescriptionAdminEntityService.addSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, List<SectionCrumb> sectionCrumb) Adds an item into the specified collectionAdminEntityServiceImpl.addSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, List<SectionCrumb> sectionCrumbs) AdminEntityService.getAdvancedCollectionRecord
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId) Gets an Entity representing a specific collection itemAdminEntityService.getAdvancedCollectionRecord
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId, String[] customCriteria) Gets an Entity representing a specific collection itemAdminEntityServiceImpl.getAdvancedCollectionRecord
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId) AdminEntityServiceImpl.getAdvancedCollectionRecord
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId, String[] customCriteria) AdminEntityService.getAllRecordsForAllSubCollections
(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb) overloading containing paging parametersAdminEntityServiceImpl.getAllRecordsForAllSubCollections
(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb) AdminEntityService.getContextSpecificRelationshipId
(ClassMetadata cmd, Entity entity, String propertyName) Returns the appropriate id to use for the given entity/metadata and prefix when dealing with collections.AdminEntityServiceImpl.getContextSpecificRelationshipId
(ClassMetadata cmd, Entity entity, String propertyName) AdminEntityService.getIdProperty
(ClassMetadata cmd) Returns the name of the property in this ClassMetadata that has field type set toSupportedFieldType.ID
AdminEntityServiceImpl.getIdProperty
(ClassMetadata cmd) AdminEntityService.getPagedRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, FetchPageRequest fetchPageRequest, String idValueOverride, List<SectionCrumb> sectionCrumbs) The same as the other getRecordsForCollection method, except that this one expects allow the caller to explicitly set the id value that will be used in the fetch instead of delegating to#getContextSpecificRelationshipId()
.AdminEntityServiceImpl.getPagedRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, FetchPageRequest fetchPageRequest, String idValueOverride, List<SectionCrumb> sectionCrumbs) AdminEntityService.getRecord
(PersistencePackageRequest request, String id, ClassMetadata cmd, boolean isCollectionRequest) Returns a specific record for the given request and primary key id/propertyAdminEntityServiceImpl.getRecord
(PersistencePackageRequest request, String id, ClassMetadata cmd, boolean isCollectionRequest) AdminEntityService.getRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, String idValueOverride, List<SectionCrumb> sectionCrumb) The same as the other getRecordsForCollection method, except that this one expects allow the caller to explicitly set the id value that will be used in the fetch instead of delegating to#getContextSpecificRelationshipId()
AdminEntityService.getRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, List<SectionCrumb> sectionCrumb) Returns the DynamicResultSet representing the records that belong to the specified collectionProperty for the given containingClass and the primary key for the containingClassAdminEntityServiceImpl.getRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, String idValueOverride, List<SectionCrumb> sectionCrumbs) AdminEntityServiceImpl.getRecordsForCollection
(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, List<SectionCrumb> sectionCrumb) AdminEntityService.getRecordsForSelectedTab
(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb, String currentTabName) Returns all records for selected tab of the specified request and its primary keyAdminEntityServiceImpl.getRecordsForSelectedTab
(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb, String currentTabName) void
AdminEntityService.populateParentRecordStructure
(PersistencePackage persistencePackage, Entity entity, ClassMetadata parentMetadata) Store parent record value, parent metadata to thePersistencePackage
void
AdminEntityServiceImpl.populateParentRecordStructure
(PersistencePackage persistencePackage, Entity entity, ClassMetadata parentMetadata) AdminEntityService.removeSubCollectionEntity
(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String alternateId, String priorKey, List<SectionCrumb> sectionCrumb) Removes the given item from the specified collection.AdminEntityService.removeSubCollectionEntity
(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String priorKey, List<SectionCrumb> sectionCrumb) Removes the given item from the specified collection.AdminEntityServiceImpl.removeSubCollectionEntity
(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String alternateId, String priorKey, List<SectionCrumb> sectionCrumbs) AdminEntityServiceImpl.removeSubCollectionEntity
(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String priorKey, List<SectionCrumb> sectionCrumbs) AdminEntityService.updateSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, String alternateId, List<SectionCrumb> sectionCrumb) Updates the specified collection itemAdminEntityService.updateSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, List<SectionCrumb> sectionCrumb) Updates the specified collection itemAdminEntityServiceImpl.updateSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, String alternateId, List<SectionCrumb> sectionCrumbs) AdminEntityServiceImpl.updateSubCollectionEntity
(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, List<SectionCrumb> sectionCrumb) protected void
AdminEntityServiceImpl.updateTabInfo
(CollectionMetadata fmd, ClassMetadata cmd, String tabName, int tabOrder) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.service.persistence
Methods in org.broadleafcommerce.openadmin.server.service.persistence that return ClassMetadataModifier and TypeMethodDescriptionPersistenceManager.buildClassMetadata
(Class<?>[] entities, PersistencePackage persistencePackage, Map<MergedPropertyType, Map<String, FieldMetadata>> mergedProperties) PersistenceManagerImpl.buildClassMetadata
(Class<?>[] entities, PersistencePackage persistencePackage, Map<MergedPropertyType, Map<String, FieldMetadata>> mergedProperties) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.service.persistence.module
Methods in org.broadleafcommerce.openadmin.server.service.persistence.module that return ClassMetadataModifier and TypeMethodDescriptionInspectHelper.buildClassMetadata
(Class<?>[] entities, PersistencePackage persistencePackage, Map<MergedPropertyType, Map<String, FieldMetadata>> mergedProperties) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.web.controller
Methods in org.broadleafcommerce.openadmin.web.controller with parameters of type ClassMetadataModifier and TypeMethodDescriptionAbstractAdminBasicOperationsControllerExtensionHandler.buildLookupListGrid
(PersistencePackageRequest ppr, ClassMetadata cmd, String owningClass, List<SectionCrumb> sectionCrumbs, org.springframework.ui.Model model, org.springframework.util.MultiValueMap<String, String> requestParams) AdminBasicOperationsControllerExtensionHandler.buildLookupListGrid
(PersistencePackageRequest ppr, ClassMetadata cmd, String owningClass, List<SectionCrumb> sectionCrumbs, org.springframework.ui.Model model, org.springframework.util.MultiValueMap<String, String> requestParams) Invoked every timeAdminBasicOperationsController#showSelectCollectionItem()
is invoked to allow the ListGrid style to be built in a different style.protected void
AdminAbstractController.extractDynamicFormFields
(ClassMetadata cmd, EntityForm entityForm) This method will scan the entityForm for all dynamic form fields and pull them out as appropriate.protected ListGrid
AdminAbstractController.getCollectionListGrid
(ClassMetadata mainMetadata, Entity entity, Property collectionProperty, org.springframework.util.MultiValueMap<String, String> requestParams, String sectionKey, List<SectionCrumb> sectionCrumbs) Convenience method for obtaining a ListGrid DTO object for a collection.protected ListGrid
AdminAbstractController.getCollectionListGrid
(ClassMetadata mainMetadata, Entity entity, Property collectionProperty, org.springframework.util.MultiValueMap<String, String> requestParams, String sectionKey, PersistenceResponse persistenceResponse, List<SectionCrumb> sectionCrumbs) Convenience method for obtaining a ListGrid DTO object for a collection.AbstractAdminAbstractControllerExtensionHandler.modifyMainActions
(ClassMetadata cmd, List<EntityFormAction> mainActions) AdminAbstractControllerExtensionHandler.modifyMainActions
(ClassMetadata cmd, List<EntityFormAction> mainActions) Extension point to override the actions that are added by default when viewing a ceiling entity for a particular section (for instance, a list of Products in the 'Product' section).AbstractAdminAbstractControllerExtensionHandler.modifyPreAddEntityForm
(EntityForm entityForm, ClassMetadata cmd, Map<String, String> pathVars) AdminAbstractControllerExtensionHandler.modifyPreAddEntityForm
(EntityForm entityForm, ClassMetadata cmd, Map<String, String> pathVars) Extension point for setting values on an EntityForm before the initial object is persisted. -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.web.controller.entity
Methods in org.broadleafcommerce.openadmin.web.controller.entity with parameters of type ClassMetadataModifier and TypeMethodDescriptionprotected void
AdminBasicEntityController.addAddActionIfAllowed
(String sectionClassName, ClassMetadata cmd, List<EntityFormAction> mainActions) Adds the "Add" button to the main entity form if the current user has permissions to create new instances of the entity and all of the fields in the entity aren't marked as read only.protected String
AdminBasicEntityController.determineEntityType
(String entityType, ClassMetadata cmd) protected String
AdminBasicEntityController.getCurrentTabName
(Map<String, String> pathVars, ClassMetadata cmd) protected String
AdminBasicEntityController.getModalForBlankEntityType
(jakarta.servlet.http.HttpServletRequest request, org.springframework.ui.Model model, String sectionKey, ClassMetadata cmd) protected Map<String,
DynamicResultSet> AdminBasicEntityController.getViewSubRecords
(jakarta.servlet.http.HttpServletRequest request, Map<String, String> pathVars, ClassMetadata cmd, Entity entity, List<SectionCrumb> crumbs) protected boolean
AdminBasicEntityController.isAddActionAllowed
(String sectionClassName, ClassMetadata cmd) protected boolean
AdminBasicEntityController.isNotReadOnly
(ClassMetadata cmd) protected EntityForm
AdminBasicEntityController.reinitializeEntityForm
(EntityForm entityForm, ClassMetadata collectionMetadata, Entity entity, Map<String, DynamicResultSet> subRecordsMap, List<SectionCrumb> sectionCrumbs) protected void
AdminBasicEntityController.setupViewEntityListBasicModel
(jakarta.servlet.http.HttpServletRequest request, ClassMetadata cmd, String sectionKey, String sectionClassName, org.springframework.ui.Model model, org.springframework.util.MultiValueMap<String, String> requestParams) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.web.form.entity
Methods in org.broadleafcommerce.openadmin.web.form.entity with parameters of type ClassMetadataModifier and TypeMethodDescriptionvoid
EntityForm.addField
(ClassMetadata cmd, Field field) void
EntityForm.addField
(ClassMetadata cmd, Field field, String groupName, Integer groupOrder, String tabName, Integer tabOrder) void
EntityForm.addHiddenField
(ClassMetadata cmd, Field field) void
EntityForm.addListGrid
(ClassMetadata cmd, ListGrid listGrid, String tabName, Integer tabOrder, String groupName, boolean isTabPresent) void
EntityForm.addMapKeyField
(ClassMetadata cmd, Field field) -
Uses of ClassMetadata in org.broadleafcommerce.openadmin.web.service
Methods in org.broadleafcommerce.openadmin.web.service with parameters of type ClassMetadataModifier and TypeMethodDescriptionprotected void
FormBuilderServiceImpl.addDeleteActionIfAllowed
(EntityForm entityForm, ClassMetadata cmd, Entity entity) Adds theDefaultEntityFormActions.DELETE
if the user is allowed to delete the entity.protected void
FormBuilderServiceImpl.addDuplicateActionIfAllowed
(EntityForm entityForm, ClassMetadata cmd) FormBuilderService.buildMainListGrid
(DynamicResultSet drs, ClassMetadata cmd, String sectionKey, List<SectionCrumb> sectionCrumbs) Builds a list grid that is typically used at the top entity level to select an entity for modification.FormBuilderServiceImpl.buildMainListGrid
(DynamicResultSet drs, ClassMetadata cmd, String sectionKey, List<SectionCrumb> sectionCrumbs) FormBuilderService.buildMapForm
(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId) Builds the EntityForm used in modal dialogs when adding items to map collections.FormBuilderService.buildMapForm
(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId, EntityForm ef) Equivalent toFormBuilderService.buildMapForm(MapMetadata, MapStructure, ClassMetadata, String)
except rather than creating a newEntityForm
this simply uses theEntityForm
that was passed in as ef.FormBuilderServiceImpl.buildMapForm
(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId) FormBuilderServiceImpl.buildMapForm
(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId, EntityForm ef) TranslationFormBuilderService.buildTranslationForm
(ClassMetadata cmd, TranslationForm formProperties, TranslationFormAction action) Builds an EntityForm used to create or edit a translation valueTranslationFormBuilderServiceImpl.buildTranslationForm
(ClassMetadata cmd, TranslationForm formProperties, TranslationFormAction action) FormBuilderService.constructSelectizeOptionMap
(DynamicResultSet drs, ClassMetadata cmd) constructs the selectize option map based on the dynamic result set and class metadataFormBuilderServiceImpl.constructSelectizeOptionMap
(DynamicResultSet drs, ClassMetadata cmd) FormBuilderService.createEntityForm
(ClassMetadata cmd, List<SectionCrumb> sectionCrumbs) Creates a new EntityForm with the a default 'Save' action.FormBuilderService.createEntityForm
(ClassMetadata cmd, Entity entity, List<SectionCrumb> sectionCrumbs) Creates a new EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity.FormBuilderService.createEntityForm
(ClassMetadata cmd, Entity entity, Map<String, DynamicResultSet> collectionRecords, List<SectionCrumb> sectionCrumbs) Builds an EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map.FormBuilderServiceImpl.createEntityForm
(ClassMetadata cmd, List<SectionCrumb> sectionCrumbs) FormBuilderServiceImpl.createEntityForm
(ClassMetadata cmd, Entity entity, List<SectionCrumb> sectionCrumbs) FormBuilderServiceImpl.createEntityForm
(ClassMetadata cmd, Entity entity, Map<String, DynamicResultSet> collectionRecords, List<SectionCrumb> sectionCrumbs) protected String
FormBuilderServiceImpl.getSecurityClassname
(EntityForm entityForm, ClassMetadata cmd) Obtains the class name suitable for passing along to theSecurityVerifier
protected boolean
FormBuilderServiceImpl.isDeletionAllowed
(EntityForm entityForm, ClassMetadata cmd, Entity entity) protected boolean
FormBuilderServiceImpl.isDuplicationAllowed
(EntityForm entityForm, ClassMetadata cmd) protected void
FormBuilderServiceImpl.populateDropdownToOneFields
(EntityForm ef, ClassMetadata cmd) void
FormBuilderService.populateEntityForm
(ClassMetadata cmd, Entity entity, Map<String, DynamicResultSet> collectionRecords, EntityForm entityForm, List<SectionCrumb> sectionCrumbs) Builds an EntityForm that has all of the appropriate fields set up along with the values for thsoe fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map.void
FormBuilderService.populateEntityForm
(ClassMetadata cmd, Entity entity, EntityForm ef, List<SectionCrumb> sectionCrumbs) Populates a given ef based on the given cmd to initially create fields with the necessary metadata and then fills those fields out based on the property values from entity.void
FormBuilderService.populateEntityForm
(ClassMetadata cmd, EntityForm ef, List<SectionCrumb> sectionCrumbs) Populates the given ef with all of the fields based on the properties from cmd.void
FormBuilderServiceImpl.populateEntityForm
(ClassMetadata cmd, Entity entity, Map<String, DynamicResultSet> collectionRecords, EntityForm ef, List<SectionCrumb> sectionCrumbs) void
FormBuilderServiceImpl.populateEntityForm
(ClassMetadata cmd, Entity entity, EntityForm ef, List<SectionCrumb> sectionCrumbs) void
FormBuilderServiceImpl.populateEntityForm
(ClassMetadata cmd, EntityForm ef, List<SectionCrumb> sectionCrumbs) void
FormBuilderService.populateEntityFormFieldValues
(ClassMetadata cmd, Entity entity, EntityForm ef) Populates the givenEntityForm
with values based on theEntity
that has been passed in.void
FormBuilderServiceImpl.populateEntityFormFieldValues
(ClassMetadata cmd, Entity entity, EntityForm ef) void
FormBuilderService.removeNonApplicableFields
(ClassMetadata cmd, EntityForm entityForm, String entityType) Loops through all of the fields that are specified in given class metadata and removes fields that are not applicable for the given polymorphic entity type from the entity form.void
FormBuilderServiceImpl.removeNonApplicableFields
(ClassMetadata cmd, EntityForm entityForm, String entityType) protected void
FormBuilderServiceImpl.setEntityFormFields
(ClassMetadata cmd, EntityForm ef, List<Property> properties) protected void
FormBuilderServiceImpl.setReadOnlyState
(EntityForm entityForm, ClassMetadata cmd, Entity entity) The given entityForm is marked as readonly for the following cases: All of the properties from cmd are readonly The user does not have the security toEntityOperationType.UPDATE
the given class name represented by the entityForm (determined byFormBuilderServiceImpl.getSecurityClassname(EntityForm, ClassMetadata)
) The user does not have the security necessary to modify the given entity according to theRowLevelSecurityProvider.canUpdate(AdminUser, Entity)
protected void
FormBuilderServiceImpl.setVisibilityBasedOnShowIfFieldEquals
(ClassMetadata cmd, Entity entity, EntityForm ef)