Package com.cmobilecom.af.model.bean

Class EntityViewConfig

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class EntityViewConfig
extends PersistenceDataViewConfig
    EntityViewConfig: viewConfig for entity backingBean.
    Since:
    4.0
    See Also:
    Serialized Form

    • Constructor Detail

      • EntityViewConfig

        public EntityViewConfig​(ViewType viewType)
        Constructor with a ViewType
        Parameters:
        viewType - ViewType.QUERY or ViewType.ENTITY

      • EntityViewConfig

        public EntityViewConfig​(org.w3c.dom.Element viewConfigElem,
                        ViewType defaultViewType,
                        DataAccessUnit dataAccessUnit)
                 throws ParseException,
                        SystemException
        Constructor with the XML element.
        Parameters:
        viewConfigElem - the root viewConfig element
        defaultViewType - default ViewType if not set in the XML
        dataAccessUnit - the associated DataAccessUnit
        Throws:
        ParseException - throw if a parsing error occurs
        SystemException - throw if any other error occurs

    • Method Detail

      • merge

        public void merge​(ViewConfig viewConfig)
        Description copied from class: ViewConfig
        Merge the viewConfig to this ViewConfig. Copy not-null values by references from the ViewConfig, overriding values in this ViewConfig.
        Overrides:
        merge in class PersistenceDataViewConfig
        Parameters:
        viewConfig - the ViewConfig from which to copy values

      • parseElement

        protected void parseElement​(org.w3c.dom.Element childElem,
                            DataAccessUnit dataAccessUnit)
                     throws ParseException,
                            SystemException
        Parse ViewConfig child element. 
        
 <viewConfig>
   <layoutType>TAB_VIEW</layoutType>
         <formDesign>FD1101</formDesign>
 
   <viewConfig name="propertyName">
      ....
   </viewConfig>
 </viewConfig>
        Overrides:
        parseElement in class PersistenceDataViewConfig
        Parameters:
        childElem - a ViewConfig child element
        dataAccessUnit - the associated dataAccessUnit
        Throws:
        ParseException - throw if a parsing error occurs
        SystemException - throw if any other error occurs

      • getShowKeywordProperties

        public java.lang.Boolean getShowKeywordProperties()
        Whether to show the properties against which keywords will match.
        Returns:
        true for showing the keyword matching properties, false otherwise. return null if not defined.
        Since:
        5.5

      • setShowKeywordProperties

        public void setShowKeywordProperties​(java.lang.Boolean showKeywordProperties)
        Set whether to show the properties against which keywords will match.
        Parameters:
        showKeywordProperties - true for showing the keyword matching properties

      • isShowKeywordProperties

        public boolean isShowKeywordProperties()
        Whether to show the properties against which keywords will match?
        Returns:
        true for showing the keyword matching properties. default is false.

      • getShowSearchOptions

        public java.lang.Boolean getShowSearchOptions()
        Whether to show search properties?
        Returns:
        true for showing search options, false otherwise. return null if not defined.
        Since:
        5.5

      • setShowSearchOptions

        public void setShowSearchOptions​(java.lang.Boolean showSearchOptions)
        Set whether to show search properties.
        Parameters:
        showSearchOptions - true for showing search options, false otherwise. null if not defined.
        Since:
        5.5

      • isShowSearchOptions

        public boolean isShowSearchOptions()
        Whether to show search properties? default is true.
        Returns:
        true for showing search options, false otherwise.
        Since:
        5.5

      • getQuickQueryProperties

        public java.util.List<java.lang.String> getQuickQueryProperties()
        Get the list of properties under the quick query tab for query view.
        Returns:
        a list of property names that can be property path such as a.b.c.

      • setQuickQueryProperties

        public void setQuickQueryProperties​(java.util.List<java.lang.String> quickQueryProperties)
        Set the list of properties under the quick query tab for query view.
        Parameters:
        quickQueryProperties - a list of property names that can be property path such as a.b.c.

      • setQuickQueryProperties

        public void setQuickQueryProperties​(java.lang.String... quickQueryProperties)
        Set the list of properties under the quick query tab for query view.
        Parameters:
        quickQueryProperties - a list of property names that can be property path such as a.b.c.

      • addBeanFlowNavigation

        public void addBeanFlowNavigation​(BeanFlowNavigation beanFlowNavigation)
        Add a bean flow navigation
        Parameters:
        beanFlowNavigation - the bean flow navigation to add

      • removeBeanFlowNavigation

        public void removeBeanFlowNavigation​(BeanFlowNavigation.Direction direction)
        Remove a bean flow navigation
        Parameters:
        direction - the direction of beanFlowNavigation to be removed

      • isBeanFlowEnabled

        public boolean isBeanFlowEnabled()
        Is bean flow enabled? If there is a BeanFlowNavigation defined for this ViewConfig, then bean flow is enabled.
        Returns:
        true if bean flow is enabled, false otherwise.

      • getQueryResultsViewConfig

        public EntityListViewConfig getQueryResultsViewConfig()
        Get the ViewConfig for query results. It is meaningful for query view.
        Returns:
        query results ViewConfig.

      • setQueryResultsViewConfig

        public void setQueryResultsViewConfig​(EntityListViewConfig queryResultViewConfig)
        Set the ViewConfig for query results. It is meaningful for query view.
        Parameters:
        queryResultViewConfig - query results ViewConfig

      • getFormDesign

        public FormDesign getFormDesign()
        Get the FormDesign for layout of properties
        Returns:
        FormDesign object

      • setFormDesign

        public void setFormDesign​(FormDesign formDesign)
        Set the FormDesign for layout of properties
        Parameters:
        formDesign - FormDesign object

      • isPropertyTabView

        public boolean isPropertyTabView()
        Whether the properties are layout using tab view with one tab for one property.
        Returns:
        true for tab view.

      • toXMLElement

        public org.w3c.dom.Element toXMLElement​(org.w3c.dom.Document document)
        Description copied from class: ViewConfig
        XML representation for viewConfig.
        Overrides:
        toXMLElement in class PersistenceDataViewConfig
        Parameters:
        document - XML document
        Returns:
        root XML element for this ViewConfig

      • getStartFormIndex

        public java.lang.Integer getStartFormIndex()
        Get start form index of entity list form beans.

        An entity can render/process a number of forms(pages) of its entity list formBeanProperties. Form ranges: 

         1. current form: startFormIndex=null, endFormIndex=null.
 2. all forms:  startFormIndex=0, endFormIndex=null.
 3. form i to j-1: startFormIndex=i, endFormIndex=j.
        Returns:
        start form index

      • setStartFormIndex

        public void setStartFormIndex​(java.lang.Integer startFormIndex)
        Set start form index of entity list form beans.

        An entity can render/process a number of forms(pages) of its entity list formBeanProperties. Form ranges: 

         1. current form: startFormIndex=null, endFormIndex=null.
 2. all forms:  startFormIndex=0, endFormIndex=null.
 3. form i to j-1: startFormIndex=i, endFormIndex=j.
        Parameters:
        startFormIndex - start form index

      • getEndFormIndex

        public java.lang.Integer getEndFormIndex()
        Get end form index of entity list form beans.

        An entity can render/process a number of forms(pages) of its entity list formBeanProperties. Form ranges: 

         1. current form: startFormIndex=null, endFormIndex=null.
 2. all forms:  startFormIndex=0, endFormIndex=null.
 3. form i to j-1: startFormIndex=i, endFormIndex=j.
        Returns:
        end form index

      • setEndFormIndex

        public void setEndFormIndex​(java.lang.Integer endFormIndex)
        Set end form index of entity list form beans.

        An entity can render/process a number of forms(pages) of its entity list formBeanProperties. Form ranges: 

         1. current form: startFormIndex=null, endFormIndex=null.
 2. all forms:  startFormIndex=0, endFormIndex=null.
 3. form i to j-1: startFormIndex=i, endFormIndex=j.
        Parameters:
        endFormIndex - end form index

      • setFormRange

        public void setFormRange​(java.lang.Integer startFormIndex,
                         java.lang.Integer endFormIndex)
        Set end form index of entity list form beans.

        An entity can render/process a number of forms(pages) of its entity list formBeanProperties. Form ranges: 

         1. current form: startFormIndex=null, endFormIndex=null.
 2. all forms:  startFormIndex=0, endFormIndex=null.
 3. form i to j-1: startFormIndex=i, endFormIndex=j.
        Parameters:
        startFormIndex - start form index of entity list form beans
        endFormIndex - end form index of entity list form beans

      • isRestoreFormIndex

        public boolean isRestoreFormIndex()
        Whether to save and restore current page(formIndex) before and after visiting entity list form beans?
        Returns:
        true for restoring formIndex. default is false.

      • setRestoreFormIndex

        public void setRestoreFormIndex​(java.lang.Boolean restoreFormIndex)
        Set whether to save and restore formIndex(current page) before and after visiting entity list form beans.
        Parameters:
        restoreFormIndex - true for restoring formIndex