Class CmsLogFilter

java.lang.Object
org.opencms.db.log.CmsLogFilter
All Implemented Interfaces:
Cloneable

public final class CmsLogFilter extends Object implements Cloneable
A filter to retrieve log entries.

Since:
8.0.0
  • Field Details

  • Method Details

    • clone

      public Object clone()
      Overrides:
      clone in class Object
      See Also:
    • excludeType

      Returns an extended filter with the given type restriction.

      Parameters:
      type - the relation type to exclude
      Returns:
      an extended filter with the given type restriction
    • filterFrom

      public CmsLogFilter filterFrom(long from)
      Returns an extended filter with the starting date restriction.

      Parameters:
      from - the starting date to filter
      Returns:
      an extended filter with the starting date restriction
    • filterResource

      public CmsLogFilter filterResource(CmsUUID structureId)
      Returns an extended filter with the given resource restriction.

      Parameters:
      structureId - the structure id to filter
      Returns:
      an extended filter with the given resource restriction
    • filterTo

      public CmsLogFilter filterTo(long to)
      Returns an extended filter with the end date restriction.

      Parameters:
      to - the end date to filter
      Returns:
      an extended filter with the end date restriction
    • filterUser

      public CmsLogFilter filterUser(CmsUUID userId)
      Returns an extended filter with the given user ID restriction.

      Parameters:
      userId - the user ID to filter
      Returns:
      an extended filter with the given user ID restriction
    • getDateFrom

      public long getDateFrom()
      Returns the starting date restriction.

      Returns:
      the starting date restriction
    • getDateTo

      public long getDateTo()
      Returns the end date restriction.

      Returns:
      the end date restriction
    • getExcludeTypes

      Returns the types to exclude.

      Returns:
      the types to exclude
    • getIncludeTypes

      Returns the types to include.

      Returns:
      the types to include
    • getStructureId

      Returns the structure Id of the resource to filter.

      Returns:
      the structure Id of the resource to filter
    • getUserId

      public CmsUUID getUserId()
      Returns the user ID restriction.

      Returns:
      the user ID restriction
    • includeType

      Returns an extended filter with the given type restriction.

      Parameters:
      type - the relation type to include
      Returns:
      an extended filter with the given type restriction
    • matchType

      public boolean matchType(CmsLogEntryType type)
      Returns true if the given log entry type matches this filter.

      Parameters:
      type - the log entry type to test
      Returns:
      true if the given log entry type matches this filter
    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: