Package com.cmobilecom.af.entity.system

Interface UserOptions

  • All Superinterfaces:
    java.lang.Cloneable, PersistenceEntity
    public interface UserOptions
extends PersistenceEntity
    UserOptions: user options such as modules and home page contents.
    Since:
    4.0

    • Field Detail

      • PROPERTY_USER

        static final java.lang.String PROPERTY_USER
        Property name: user
        See Also:
        Constant Field Values

      • PROPERTY_MODULES

        static final java.lang.String PROPERTY_MODULES
        Property name: modules
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_HOME_ON_LOGIN

        static final java.lang.String PROPERTY_SHOW_HOME_ON_LOGIN
        Property name: showHomeOnLogin
        See Also:
        Constant Field Values

      • PROPERTY_HOME_PAGE

        static final java.lang.String PROPERTY_HOME_PAGE
        Property name: homePage for manage center
        See Also:
        Constant Field Values

      • PROPERTY_HOME_CONTENTS

        static final java.lang.String PROPERTY_HOME_CONTENTS
        Property name: homeContents
        See Also:
        Constant Field Values

      • PROPERTY_LAYOUT_TYPE

        static final java.lang.String PROPERTY_LAYOUT_TYPE
        Property name: layoutType
        See Also:
        Constant Field Values

      • PROPERTY_LAYOUT_COLUMNS

        static final java.lang.String PROPERTY_LAYOUT_COLUMNS
        Property name: layoutColumns
        See Also:
        Constant Field Values

    • Method Detail

      • getUser

        User getUser()
        Get the user who owns this userOptions.
        Returns:
        the user of this UserOptions

      • setUser

        void setUser​(User user)
        Set the user who owns this userOptions.
        Parameters:
        user - the user of this UserOptions

      • getModules

        java.lang.String getModules()
        Get the modules to show in manage center.
        Returns:
        comma separated module names

      • setModules

        void setModules​(java.lang.String modules)
        Set the modules to show in manage center.
        Parameters:
        modules - comma separated module names

      • getShowHomeOnLogin

        java.lang.Boolean getShowHomeOnLogin()
        Whether to show home page contents when login to manage center?
        Returns:
        true if showing home page contents.

      • setShowHomeOnLogin

        void setShowHomeOnLogin​(java.lang.Boolean showHomeOnLogin)
        Set whether to show home page contents when login to manage center.
        Parameters:
        showHomeOnLogin - true if showing home page contents.

      • getHomePage

        Page getHomePage()
        Get the home page for manage center. If null, getHomeContents() will be used to build home contents.
        Returns:
        the page to show for manage center

      • setHomePage

        void setHomePage​(Page homePage)
        Set the home page for manage center. If null, getHomeContents() will be used to build home contents.
        Parameters:
        homePage - the page to show for manage center

      • getHomeContents

        java.lang.String getHomeContents()
        Get the contents to show for home page in manage center. Ignored if getHomePage() is not null.
        Returns:
        comma separated content names

      • setHomeContents

        void setHomeContents​(java.lang.String homeContents)
        Set the contents to show for home page in manage center. Ignored if getHomePage() is not null.
        Parameters:
        homeContents - comma separated content names

      • getLayoutType

        java.lang.Integer getLayoutType()
        Get the layout type of the region showing the home contents.
        Returns:
        LayoutType ordinal value
        Since:
        5.6

      • setLayoutType

        void setLayoutType​(java.lang.Integer layoutType)
        Set the layout type of the region showing the home contents.
        Parameters:
        layoutType - LayoutType ordinal value
        Since:
        5.6

      • getLayoutColumns

        java.lang.Integer getLayoutColumns()
        Get the number of columns for grid or columnView layout. default is 1.
        Returns:
        number of columns
        Since:
        5.6

      • setLayoutColumns

        void setLayoutColumns​(java.lang.Integer columns)
        Set the number of columns for grid or columnView layout. default is 1.
        Parameters:
        columns - number of columns.
        Since:
        5.6