Interface AuditLogBuilder

  • All Known Implementing Classes:
    AuditLogBuilderImpl

    public interface AuditLogBuilder
    Builds the list of the audit log actions according to the filtering and sorting rules
    Author:
    Maxim.Manuylov Date: 27.04.2009
    • Method Detail

      • setObjectId

        void setObjectId​(@NotNull
                         String objectId)
        Sets object id we are interested in
        Parameters:
        objectId - id of the object
      • setObjectIds

        void setObjectIds​(@NotNull
                          Collection<String> objectIds)
        Sets collection of ids of objects we're interested in.
        Parameters:
        objectIds - ids of objects
      • setUserId

        void setUserId​(long userId)
        Sets user id we are interested in
        Parameters:
        userId - id of the user
      • setUserAction

        void setUserAction​(boolean userAction)
        Only retrieve actions performed by users
        Parameters:
        userAction - if true, only users actions are returned, if false all actions are returned
      • setCommentId

        void setCommentId​(long commentId)
        Sets comment id we are interested in
        Parameters:
        commentId - id of the comment
      • setActionTypeSet

        void setActionTypeSet​(ActionTypeSet actionTypeSet)
        Sets a set of action types we are interested in
        Parameters:
        actionTypeSet - action type set
      • setActionTypes

        void setActionTypes​(ActionType... actionTypes)
        Sets a set of action types we are interested in
        Parameters:
        actionTypes - action types
      • addFilter

        void addFilter​(@NotNull
                       AuditLogFilter filter)
        Adds a filter for log actions. Action will be accepted if all the filters accept it.
        Parameters:
        filter - filter
      • getLogActions

        @NotNull
        List<AuditLogAction> getLogActions​(int maxActions)
        Returns built list of the audit log actions according to all filters.
        Parameters:
        maxActions - if -1 returns all actions, otherwise returns no more than specified number of actions
        Returns:
        built list of the audit log actions according to all filters
      • findLastAction

        @Nullable
        AuditLogAction findLastAction()
        Returns:
        the last action corresponding to specified filters or null, if there is no such action
        Since:
        2017.1
      • getAllObjectIds

        @NotNull
        Set<String> getAllObjectIds​(@NotNull
                                    ObjectType objectType)
        Returns set of all distinct ids for objects of the specified type
        Returns:
        set of all distinct ids for objects of the specified type