org.opencms.db

类 CmsSubscriptionFilter

java.lang.Object

org.opencms.db.CmsVisitedByFilter

org.opencms.db.CmsSubscriptionFilter

public class CmsSubscriptionFilter
extends CmsVisitedByFilter

Provides filters for getting resources subscribed by a user or group in a specified time range.

从以下版本开始:

8.0

构造器概要

构造器

构造器和说明
CmsSubscriptionFilter() Constructor, without parameters.
CmsSubscriptionFilter(CmsObject cms) Constructor, setting the user to the current user from the context.
CmsSubscriptionFilter(CmsObject cms, boolean addUserGroups) Constructor, setting the user to the current user from the context.

方法概要

方法

限定符和类型	方法和说明
void	addGroup(CmsGroup group) Adds a group to the list of groups to check subscribed resources for.
java.lang.Object	clone()
java.util.List<CmsGroup>	getGroups() Returns the groups to check subscribed resources for.
CmsSubscriptionReadMode	getMode() Returns the mode to read subscribed resources.
void	setGroups(java.util.List<CmsGroup> groups) Sets the groups to check subscribed resources for.
void	setMode(CmsSubscriptionReadMode mode) Sets the mode to read subscribed resources.
void	setUserGroups(CmsObject cms) Sets the groups of the user currently set in this filter as the list of groups to check subscribed resources for.
java.lang.String	toString() Returns a user readable representation of the filter.

从类继承的方法 org.opencms.db.CmsVisitedByFilter

getFromDate, getParentPath, getToDate, getUser, isIncludeSubFolders, setFromDate, setIncludeSubfolders, setParentPath, setParentResource, setToDate, setUser, setVisitedDates

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsSubscriptionFilter

public CmsSubscriptionFilter()

Constructor, without parameters.

It is required to set the user or group manually if using this constructor.

CmsSubscriptionFilter

public CmsSubscriptionFilter(CmsObject cms)

Constructor, setting the user to the current user from the context.

参数:

cms - the current users context

CmsSubscriptionFilter

public CmsSubscriptionFilter(CmsObject cms,
                     boolean addUserGroups)

Constructor, setting the user to the current user from the context.

参数:

cms - the current users context

addUserGroups - determines if the groups of the current user should be added to the list of groups of the filter

方法详细资料

addGroup

public void addGroup(CmsGroup group)

Adds a group to the list of groups to check subscribed resources for.

参数:

group - the group to add

clone

public java.lang.Object clone()

覆盖:

clone 在类中 CmsVisitedByFilter

另请参阅:

Object.clone()

getGroups

public java.util.List<CmsGroup> getGroups()

Returns the groups to check subscribed resources for.

返回:

the groups to check subscribed resources for

getMode

public CmsSubscriptionReadMode getMode()

Returns the mode to read subscribed resources.

返回:

the mode to read subscribed resources

setGroups

public void setGroups(java.util.List<CmsGroup> groups)

Sets the groups to check subscribed resources for.

参数:

groups - the groups to check subscribed resources for

setMode

public void setMode(CmsSubscriptionReadMode mode)

Sets the mode to read subscribed resources.

参数:

mode - the mode to read subscribed resources

setUserGroups

public void setUserGroups(CmsObject cms)

Sets the groups of the user currently set in this filter as the list of groups to check subscribed resources for.

参数:

cms - the current users context

toString

public java.lang.String toString()

Returns a user readable representation of the filter.

覆盖:

toString 在类中 CmsVisitedByFilter

另请参阅:

Object.toString()