Package org.alfresco.service.cmr.audit

Class AuditQueryParameters

  • public class AuditQueryParameters
extends Object
    Parameters controlling audit queries.
    Since:
    3.3
    Author:
    Derek Hulley

    • Constructor Detail

      • AuditQueryParameters

        public AuditQueryParameters()
        Defaults:
         forward = true;
         searchKeyValues = emptylist
         others = null

    • Method Detail

      • isZeroResultQuery

        public boolean isZeroResultQuery()
        Returns:
        Returns true if any query using these parameters will necessarily yield no results.

      • isForward

        public boolean isForward()
        Returns:
        Returns true if the results are ordered by increasing ID

      • setForward

        public void setForward​(boolean forward)
        Parameters:
        forward - true for results to ordered from first to last, or false to order from last to first

      • getApplicationName

        public String getApplicationName()
        Returns:
        Returns if not null, find entries logged against this application

      • setApplicationName

        public void setApplicationName​(String applicationName)
        Parameters:
        applicationName - if not null, find entries logged against this application

      • getUser

        public String getUser()
        Returns:
        Returns if not null, find entries logged against this user

      • setUser

        public void setUser​(String user)
        Parameters:
        user - if not null, find entries logged against this user

      • getFromId

        public Long getFromId()
        Returns:
        Returns the ID to search from (null to start at the beginning)

      • setFromId

        public void setFromId​(Long fromId)
        Parameters:
        fromId - the ID to search from (null to start at the beginning)

      • getToId

        public Long getToId()
        Returns:
        Returns the ID to search to (null for no limit)

      • setToId

        public void setToId​(Long toId)
        Parameters:
        toId - the start ID to search to (null for no limit)

      • getFromTime

        public Long getFromTime()
        Returns:
        Returns the start search time (null to start at the beginning)

      • setFromTime

        public void setFromTime​(Long fromTime)
        Parameters:
        fromTime - the start search time (null to start at the beginning)

      • getToTime

        public Long getToTime()
        Returns:
        Returns the end search time (null for no limit)

      • setToTime

        public void setToTime​(Long toTime)
        Parameters:
        toTime - the end search time (null for no limit)

      • getSearchKeyValues

        public List<Pair<String,​Serializable>> getSearchKeyValues()
        Returns:
        Returns the search keys for the query

      • addSearchKey

        public void addSearchKey​(String searchKey,
                         Serializable searchValue)
        Add a search key pair.
        Parameters:
        searchKey - the path-value pair. Either the path (first value) or the search value (second value) may be null, but not both.