Class CmsSubscriptionFilter

    • Constructor Detail

      • CmsSubscriptionFilter

        public CmsSubscriptionFilter()
        Constructor, without parameters.

        It is required to set the user or group manually if using this constructor.

      • CmsSubscriptionFilter

        public CmsSubscriptionFilter​(CmsObject cms)
        Constructor, setting the user to the current user from the context.

        Parameters:
        cms - the current users context
      • CmsSubscriptionFilter

        public CmsSubscriptionFilter​(CmsObject cms,
                                     boolean addUserGroups)
        Constructor, setting the user to the current user from the context.

        Parameters:
        cms - the current users context
        addUserGroups - determines if the groups of the current user should be added to the list of groups of the filter
    • Method Detail

      • addGroup

        public void addGroup​(CmsGroup group)
        Adds a group to the list of groups to check subscribed resources for.

        Parameters:
        group - the group to add
      • getGroups

        public java.util.List<CmsGroupgetGroups()
        Returns the groups to check subscribed resources for.

        Returns:
        the groups to check subscribed resources for
      • setGroups

        public void setGroups​(java.util.List<CmsGroup> groups)
        Sets the groups to check subscribed resources for.

        Parameters:
        groups - the groups to check subscribed resources for
      • setMode

        public void setMode​(CmsSubscriptionReadMode mode)
        Sets the mode to read subscribed resources.

        Parameters:
        mode - the mode to read subscribed resources
      • setUserGroups

        public void setUserGroups​(CmsObject cms)
        Sets the groups of the user currently set in this filter as the list of groups to check subscribed resources for.

        Parameters:
        cms - the current users context
      • toString

        public java.lang.String toString()
        Returns a user readable representation of the filter.

        Overrides:
        toString in class CmsVisitedByFilter
        See Also:
        Object.toString()