Uses of Class
org.broadleafcommerce.openadmin.dto.ClassMetadata

Packages that use ClassMetadata

Package	Description
org.broadleafcommerce.openadmin.dto
org.broadleafcommerce.openadmin.server.dao
org.broadleafcommerce.openadmin.server.dao.provider.metadata
org.broadleafcommerce.openadmin.server.security.service
org.broadleafcommerce.openadmin.server.service
org.broadleafcommerce.openadmin.server.service.persistence
org.broadleafcommerce.openadmin.server.service.persistence.module
org.broadleafcommerce.openadmin.web.controller
org.broadleafcommerce.openadmin.web.controller.entity
org.broadleafcommerce.openadmin.web.form.entity
org.broadleafcommerce.openadmin.web.service

Uses of ClassMetadata in org.broadleafcommerce.openadmin.dto

Methods in org.broadleafcommerce.openadmin.dto that return ClassMetadata

Modifier and Type	Method and Description
ClassMetadata	DynamicResultSet.getClassMetaData()

Methods in org.broadleafcommerce.openadmin.dto with parameters of type ClassMetadata

Modifier and Type	Method and Description
void	DynamicResultSet.setClassMetaData(ClassMetadata classMetaData)

Constructors in org.broadleafcommerce.openadmin.dto with parameters of type ClassMetadata

Constructor and Description
DynamicResultSet(ClassMetadata classMetaData)
DynamicResultSet(ClassMetadata classMetaData, Entity[] records, Integer totalRecords)

Uses of ClassMetadata in org.broadleafcommerce.openadmin.server.dao

Methods in org.broadleafcommerce.openadmin.server.dao with parameters of type ClassMetadata

Modifier and Type	Method and Description
void	Metadata.buildAdditionalTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd, Map<String,TabMetadata> metadata)
Map<String,TabMetadata>	DynamicEntityDaoImpl.getTabAndGroupMetadata(Class<?>[] entities, ClassMetadata cmd)
Map<String,TabMetadata>	DynamicEntityDao.getTabAndGroupMetadata(Class<?>[] clazz, 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 ClassMetadata

Modifier and Type	Method and Description
MetadataProviderResponse	EntityMetadataProvider.addTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd, Map<String,TabMetadata> metadata)
MetadataProviderResponse	BasicEntityMetadataProvider.addTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd, Map<String,TabMetadata> metadata)
MetadataProviderResponse	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 ClassMetadata

Modifier and Type	Method and Description
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)
boolean	AbstractRowLevelSecurityProvider.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 ClassMetadata

Modifier and Type	Method and Description
PersistenceResponse	AdminEntityServiceImpl.addSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, List<SectionCrumb> sectionCrumbs)
PersistenceResponse	AdminEntityService.addSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, List<SectionCrumb> sectionCrumb) Adds an item into the specified collection
PersistenceResponse	AdminEntityServiceImpl.getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId)
PersistenceResponse	AdminEntityService.getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId) Gets an Entity representing a specific collection item
PersistenceResponse	AdminEntityServiceImpl.getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId, String[] customCriteria)
PersistenceResponse	AdminEntityService.getAdvancedCollectionRecord(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, String collectionItemId, List<SectionCrumb> sectionCrumbs, String alternateId, String[] customCriteria) Gets an Entity representing a specific collection item
String	AdminEntityServiceImpl.getContextSpecificRelationshipId(ClassMetadata cmd, Entity entity, String propertyName)
String	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.
String	AdminEntityServiceImpl.getIdProperty(ClassMetadata cmd)
String	AdminEntityService.getIdProperty(ClassMetadata cmd) Returns the name of the property in this ClassMetadata that has field type set to SupportedFieldType.ID
PersistenceResponse	AdminEntityServiceImpl.getRecord(PersistencePackageRequest request, String id, ClassMetadata cmd, boolean isCollectionRequest)
PersistenceResponse	AdminEntityService.getRecord(PersistencePackageRequest request, String id, ClassMetadata cmd, boolean isCollectionRequest) Returns a specific record for the given request and primary key id/property
PersistenceResponse	AdminEntityServiceImpl.getRecordsForCollection(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, List<SectionCrumb> sectionCrumb)
PersistenceResponse	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 containingClass
PersistenceResponse	AdminEntityServiceImpl.getRecordsForCollection(ClassMetadata containingClassMetadata, Entity containingEntity, Property collectionProperty, FilterAndSortCriteria[] fascs, Integer startIndex, Integer maxIndex, String idValueOverride, List<SectionCrumb> sectionCrumbs)
PersistenceResponse	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()
Map<String,DynamicResultSet>	AdminEntityServiceImpl.getRecordsForSelectedTab(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb, String currentTabName)
Map<String,DynamicResultSet>	AdminEntityService.getRecordsForSelectedTab(ClassMetadata cmd, Entity containingEntity, List<SectionCrumb> sectionCrumb, String currentTabName) Returns all records for selected tab of the specified request and its primary key
PersistenceResponse	AdminEntityServiceImpl.removeSubCollectionEntity(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String priorKey, List<SectionCrumb> sectionCrumbs)
PersistenceResponse	AdminEntityService.removeSubCollectionEntity(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String priorKey, List<SectionCrumb> sectionCrumb) Removes the given item from the specified collection.
PersistenceResponse	AdminEntityServiceImpl.removeSubCollectionEntity(ClassMetadata mainMetadata, Property field, Entity parentEntity, String itemId, String alternateId, String priorKey, List<SectionCrumb> sectionCrumbs)
PersistenceResponse	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.
PersistenceResponse	AdminEntityServiceImpl.updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, List<SectionCrumb> sectionCrumb)
PersistenceResponse	AdminEntityService.updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, List<SectionCrumb> sectionCrumb) Updates the specified collection item
PersistenceResponse	AdminEntityServiceImpl.updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, String alternateId, List<SectionCrumb> sectionCrumbs)
PersistenceResponse	AdminEntityService.updateSubCollectionEntity(EntityForm entityForm, ClassMetadata mainMetadata, Property field, Entity parentEntity, String collectionItemId, String alternateId, List<SectionCrumb> sectionCrumb) Updates the specified collection item
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 ClassMetadata

Modifier and Type	Method and Description
ClassMetadata	PersistenceManagerImpl.buildClassMetadata(Class<?>[] entities, PersistencePackage persistencePackage, Map<MergedPropertyType,Map<String,FieldMetadata>> mergedProperties)
ClassMetadata	PersistenceManager.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 ClassMetadata

Modifier and Type	Method and Description
ClassMetadata	InspectHelper.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 ClassMetadata

Modifier and Type	Method and Description
ExtensionResultStatusType	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 time AdminBasicOperationsController#showSelectCollectionItem() is invoked to allow the ListGrid style to be built in a different style.
ExtensionResultStatusType	AbstractAdminBasicOperationsControllerExtensionHandler.buildLookupListGrid(PersistencePackageRequest ppr, ClassMetadata cmd, String owningClass, List<SectionCrumb> sectionCrumbs, org.springframework.ui.Model model, org.springframework.util.MultiValueMap<String,String> requestParams)
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.
ExtensionResultStatusType	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).
void	MainEntityActionsExtensionHandler.modifyMainActions(ClassMetadata cmd, List<EntityFormAction> mainActions) Deprecated. 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).
ExtensionResultStatusType	AbstractAdminAbstractControllerExtensionHandler.modifyMainActions(ClassMetadata cmd, List<EntityFormAction> mainActions)

Uses of ClassMetadata in org.broadleafcommerce.openadmin.web.controller.entity

Methods in org.broadleafcommerce.openadmin.web.controller.entity with parameters of type ClassMetadata

Modifier and Type	Method and Description
protected 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 boolean	AdminBasicEntityController.isAddActionAllowed(String sectionClassName, ClassMetadata cmd)
protected void	AdminBasicEntityController.setupViewEntityListBasicModel(javax.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 ClassMetadata

Modifier and Type	Method and Description
void	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 ClassMetadata

Modifier and Type	Method and Description
protected void	FormBuilderServiceImpl.addDeleteActionIfAllowed(EntityForm entityForm, ClassMetadata cmd, Entity entity) Adds the DefaultEntityFormActions.DELETE if the user is allowed to delete the entity.
ListGrid	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.
ListGrid	FormBuilderServiceImpl.buildMainListGrid(DynamicResultSet drs, ClassMetadata cmd, String sectionKey, List<SectionCrumb> sectionCrumbs)
EntityForm	FormBuilderService.buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId) Builds the EntityForm used in modal dialogs when adding items to map collections.
EntityForm	FormBuilderServiceImpl.buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId)
EntityForm	FormBuilderService.buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId, EntityForm ef) Equivalent to FormBuilderService.buildMapForm(MapMetadata, MapStructure, ClassMetadata, String) except rather than creating a new EntityForm this simply uses the EntityForm that was passed in as ef.
EntityForm	FormBuilderServiceImpl.buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId, EntityForm ef)
EntityForm	TranslationFormBuilderService.buildTranslationForm(ClassMetadata cmd, TranslationForm formProperties, TranslationFormAction action) Builds an EntityForm used to create or edit a translation value
EntityForm	TranslationFormBuilderServiceImpl.buildTranslationForm(ClassMetadata cmd, TranslationForm formProperties, TranslationFormAction action)
Map<String,Object>	FormBuilderService.constructSelectizeOptionMap(DynamicResultSet drs, ClassMetadata cmd) constructs the selectize option map based on the dynamic result set and class metadata
Map<String,Object>	FormBuilderServiceImpl.constructSelectizeOptionMap(DynamicResultSet drs, ClassMetadata cmd)
EntityForm	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.
EntityForm	FormBuilderServiceImpl.createEntityForm(ClassMetadata cmd, Entity entity, List<SectionCrumb> sectionCrumbs)
EntityForm	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.
EntityForm	FormBuilderServiceImpl.createEntityForm(ClassMetadata cmd, Entity entity, Map<String,DynamicResultSet> collectionRecords, List<SectionCrumb> sectionCrumbs)
EntityForm	FormBuilderService.createEntityForm(ClassMetadata cmd, List<SectionCrumb> sectionCrumbs) Creates a new EntityForm with the a default 'Save' action.
EntityForm	FormBuilderServiceImpl.createEntityForm(ClassMetadata cmd, List<SectionCrumb> sectionCrumbs)
protected String	FormBuilderServiceImpl.getSecurityClassname(EntityForm entityForm, ClassMetadata cmd) Obtains the class name suitable for passing along to the SecurityVerifier
protected void	FormBuilderServiceImpl.populateDropdownToOneFields(EntityForm ef, ClassMetadata cmd)
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	FormBuilderServiceImpl.populateEntityForm(ClassMetadata cmd, Entity entity, EntityForm ef, List<SectionCrumb> sectionCrumbs)
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, EntityForm ef, List<SectionCrumb> sectionCrumbs)
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	FormBuilderServiceImpl.populateEntityForm(ClassMetadata cmd, Entity entity, Map<String,DynamicResultSet> collectionRecords, EntityForm ef, List<SectionCrumb> sectionCrumbs)
void	FormBuilderService.populateEntityFormFieldValues(ClassMetadata cmd, Entity entity, EntityForm ef) Populates the given EntityForm with values based on the Entity 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 to EntityOperationType.UPDATE the given class name represented by the entityForm (determined by FormBuilderServiceImpl.getSecurityClassname(EntityForm, ClassMetadata)) The user does not have the security necessary to modify the given entity according to the RowLevelSecurityService#canUpdate(Entity)