Package org.opencms.db.log
Class CmsLogFilter
java.lang.Object
org.opencms.db.log.CmsLogFilter
- All Implemented Interfaces:
Cloneable
A filter to retrieve log entries.
- Since:
- 8.0.0
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionclone()
excludeType
(CmsLogEntryType type) Returns an extended filter with the given type restriction.filterFrom
(long from) Returns an extended filter with the starting date restriction.filterResource
(CmsUUID structureId) Returns an extended filter with the given resource restriction.filterTo
(long to) Returns an extended filter with the end date restriction.filterUser
(CmsUUID userId) Returns an extended filter with the given user ID restriction.long
Returns the starting date restriction.long
Returns the end date restriction.Returns the types to exclude.Returns the types to include.Returns the structure Id of the resource to filter.Returns the user ID restriction.includeType
(CmsLogEntryType type) Returns an extended filter with the given type restriction.boolean
matchType
(CmsLogEntryType type) Returnstrue
if the given log entry type matches this filter.toString()
-
Field Details
-
ALL
To filter all.
-
-
Method Details
-
clone
-
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
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
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
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
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
Returns the starting date restriction.- Returns:
- the starting date restriction
-
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
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
Returnstrue
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
-