Package org.silverpeas.core.notification.user.server.channel.silvermail

Class SilvermailCriteria

  • public class SilvermailCriteria
extends Object
    Class that permits to set message search criteria for user notification.
    Author:
    Yohann Chastagnier

    • Method Detail

      • get

        public static SilvermailCriteria get()
        Initializes user notification search criteria.
        Returns:
        an instance of user notification criteria.

      • byId

        public SilvermailCriteria byId​(Long... ids)
        Sets the criteria of user identifier.
        Parameters:
        ids - the message identifiers.
        Returns:
        itself.

      • aboutUser

        public SilvermailCriteria aboutUser​(String userId)
        Sets the criteria of user identifier.
        Parameters:
        userId - the identifier of a user.
        Returns:
        itself.

      • into

        public SilvermailCriteria into​(String folderName)
        Sets the criteria of folder name.
        Parameters:
        folderName - the name of a folder.
        Returns:
        itself.

      • unread

        public SilvermailCriteria unread()
        Sets read user notification.
        Returns:
        itself.

      • paginatedBy

        public SilvermailCriteria paginatedBy​(PaginationPage pagination)
        Sets the criteria of pagination.
        Parameters:
        pagination - the pagination.
        Returns:
        itself.

      • processWith

        public void processWith​(SilvermailCriteriaProcessor processor)
        Processes this criteria with the specified processor. It chains in a given order the different criterion to process.
        Parameters:
        processor - the processor to use for processing each criterion in this criteria.