Package com.znize.platform.model.module
Interface ViewBinding
-
public interface ViewBindingViewBinding interface.- Since:
- 6.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classViewBinding.TypeViewBinding types.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.Class,TypeMapping.EntityTypeName>getEntityTypeNameMap()Get type name mappings.ModulegetModule()Get the associated module.ViewBinding.TypegetType()Get viewBinding type.voidhandleEvent(ModuleEvent event)Handle the event.voidregisterEntityBackingBeans(ViewBindingBeanRegistry registry)Register EntityBackingBeans for this view binding.voidregisterEntityListBackingBeans(ViewBindingBeanRegistry registry)Register EntityListBackingBeans for this view binding.voidregisterIcons(ViewBindingBeanRegistry registry)Register icons for this view binding.voidsetModule(Module module)Set the associated module.
-
-
-
Method Detail
-
getModule
Module getModule()
Get the associated module.- Returns:
- module object
-
setModule
void setModule(Module module)
Set the associated module. This method will be called during system initialization.- Parameters:
module- the module to set
-
getType
ViewBinding.Type getType()
Get viewBinding type.- Returns:
- type enum
-
getEntityTypeNameMap
java.util.Map<java.lang.Class,TypeMapping.EntityTypeName> getEntityTypeNameMap()
Get type name mappings. The names are not localized, and resource bundle will be used for displaying entity type names.Default singular name is entity name that is annotated in @Entity(name="Employee"). Default plural name is singular name + s ("ies" for ending y, "es" for ending h/s/x).
- Returns:
- a map from entity type to (entity singular name, entity plural name)
-
registerEntityBackingBeans
void registerEntityBackingBeans(ViewBindingBeanRegistry registry)
Register EntityBackingBeans for this view binding.- Parameters:
registry- a ViewBindingBeanRegistry object
-
registerEntityListBackingBeans
void registerEntityListBackingBeans(ViewBindingBeanRegistry registry)
Register EntityListBackingBeans for this view binding.- Parameters:
registry- a ViewBindingBeanRegistry object
-
registerIcons
void registerIcons(ViewBindingBeanRegistry registry)
Register icons for this view binding.- Parameters:
registry- a ViewBindingBeanRegistry object
-
handleEvent
void handleEvent(ModuleEvent event) throws SystemException
Handle the event. A viewBinding can handle the event if interested.- Parameters:
event- the event to handle- Throws:
SystemException- throw if an error occurs
-
-