Package org.opencms.db

Class CmsVisitEntryFilter

java.lang.Object

org.opencms.db.CmsVisitEntryFilter

All Implemented Interfaces:

java.lang.Cloneable

public final class CmsVisitEntryFilter
extends java.lang.Object
implements java.lang.Cloneable

A filter which contains criteria for reading CmsVisitEntry instances from the database.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static CmsVisitEntryFilter	ALL	To filter all.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
CmsVisitEntryFilter	filterFrom(long from)	Returns an extended filter with the starting date restriction.
CmsVisitEntryFilter	filterResource(CmsUUID structureId)	Returns an extended filter with the given resource restriction.
CmsVisitEntryFilter	filterTo(long to)	Returns an extended filter with the end date restriction.
CmsVisitEntryFilter	filterUser(CmsUUID userId)	Returns an extended filter with the given user ID restriction.
long	getDateFrom()	Returns the starting date restriction.
long	getDateTo()	Returns the end date restriction.
CmsUUID	getStructureId()	Returns the structure Id of the resource to filter.
CmsUUID	getUserId()	Returns the user ID restriction.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final CmsVisitEntryFilter ALL

To filter all.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

filterFrom

public CmsVisitEntryFilter 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 CmsVisitEntryFilter 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 CmsVisitEntryFilter 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 CmsVisitEntryFilter 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

getStructureId

public CmsUUID 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()