Package com.jalios.jcms.publicationfollower

Class PublicationFollowerManager

java.lang.Object

com.jalios.jcms.publicationfollower.PublicationFollowerManager

All Implemented Interfaces:

DBConstants, JPropertiesListener

public class PublicationFollowerManager
extends java.lang.Object
implements DBConstants, JPropertiesListener

This class manages PublicationFollower

Since:

jcms-7.0.0

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PUBLICATION_FOLLOWER_AUTO_ENABLED
static java.lang.String	PUBLICATION_ID_FIELD
static java.lang.String	REVISION

Fields inherited from interface com.jalios.jcms.db.DBConstants

ALL_CATEGORIES_SET_FIELD, ATTACH_WS_SET_FIELD, AUTH_GRP_SET_FIELD, AUTH_MBR_SET_FIELD, AUTHOR_ID_FIELD, CATEGORIES_SET_FIELD, CDATE_FIELD, CHANNEL_JCMSDB_PROP, DBDATA_URID, HAS_ATTACH_WS_FIELD, HAS_NO_READ_RIGHTS, HIBERNATE_MAPPING_ADATE, HIBERNATE_MAPPING_AUTHOR, HIBERNATE_MAPPING_CDATE, HIBERNATE_MAPPING_EDATE, HIBERNATE_MAPPING_HAS_ATTACH_WS, HIBERNATE_MAPPING_HASNOREADRIGHTS, HIBERNATE_MAPPING_MAININSTANCE_ID, HIBERNATE_MAPPING_MAJORVERSION, HIBERNATE_MAPPING_MDATE, HIBERNATE_MAPPING_MERGE_DATE, HIBERNATE_MAPPING_MERGE_ID, HIBERNATE_MAPPING_MINORVERSION, HIBERNATE_MAPPING_OPAUTHOR, HIBERNATE_MAPPING_PDATE, HIBERNATE_MAPPING_PSTATUS, HIBERNATE_MAPPING_READ_ACK, HIBERNATE_MAPPING_READERCOUNT, HIBERNATE_MAPPING_RESTRICTIVE_UPDATE_RIGHTS, HIBERNATE_MAPPING_TITLE, HIBERNATE_MAPPING_TRACKED, HIBERNATE_MAPPING_UDATE, HIBERNATE_MAPPING_VOTECOUNT, HIBERNATE_MAPPING_VOTESCORE, HIBERNATE_MAPPING_WORKFLOW_ID, HIBERNATE_MAPPING_WORKSPACE_ID, MAX_HIBERNATE_MAPPING_PUBLICATION, MDATE_FIELD, OPAUTHOR_ID_FIELD, PSTATUS_FIELD, ROW_ID_FIELD, SCROLL_FETCH_SIZE, WORKFLOW_ID_FIELD, WORKSPACE_ID_FIELD

Method Summary

Modifier and Type	Method	Description
void	addFollower(Publication pub, Member mbr)	Adds the given member as follower of the given publication.
boolean	canFollow(Member mbr, Publication pub)	Returns true if the given member can follow the given publication.
java.util.List<Publication>	getFollowedPublicationList(Member mbr)	Returns publications followed by the given member.
java.util.List<Member>	getFollowerList(Publication pub, boolean searchParents)	Returns all the followers of the given publication.
static PublicationFollowerManager	getInstance()
int	getPublicationFollowerCount(Publication pub, boolean searchParents)	Returns the PublicationFollower count attached to the given publication.
java.util.List<PublicationFollower>	getPublicationFollowerList(Publication pub, boolean searchParents)	Returns the PublicationFollower list attached to the given publication.
boolean	isAutoFollowEnabled()	Returns true if auto follow is enabled (A member is added to the PublicationFollower of the publication he creates)
boolean	isFollowed(Publication pub, Member mbr)	Returns true if the given publication is followed by the given member.
void	notifyFollowers(Publication pub, Member opAuthor, java.util.Map context)	Notify all the follower of the given publication.
void	notifyFollowers(Publication pub, Member opAuthor, java.util.Map context, boolean searchParents)	Notify all the follower of the given publication.
void	notifyFollowers(Publication pub, Member opAuthor, java.util.Map context, Publication parent)	Notify all the follower of the given publication.
void	propertiesChange(JProperties properties)	Invoked after properties have been modified in JCMS and save on disk.
void	removeAllFollowers(Publication pub)	Removes all the followers for the given publication.
void	removeFollower(Publication pub, Member mbr)	Removes the given members from the followers of the given publication.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

PUBLICATION_ID_FIELD

public static final java.lang.String PUBLICATION_ID_FIELD

See Also:

Constant Field Values

PUBLICATION_FOLLOWER_AUTO_ENABLED

public static final java.lang.String PUBLICATION_FOLLOWER_AUTO_ENABLED

See Also:

Constant Field Values

Method Detail

getInstance

public static PublicationFollowerManager getInstance()

propertiesChange

public void propertiesChange(JProperties properties)

Description copied from interface: JPropertiesListener

Invoked after properties have been modified in JCMS and save on disk.

You cannot alter the value received in parameters.

Note that properties parameter may be null, a limited set of site properties, or all site properties.

To check that a property has been modified, reload the "current" property instead using channel.getProperties or channel.getProperty.

Specified by:

propertiesChange in interface JPropertiesListener

Parameters:

properties - the properties which have been submitted to change

isAutoFollowEnabled

public boolean isAutoFollowEnabled()

Returns true if auto follow is enabled (A member is added to the PublicationFollower of the publication he creates)

Returns:

true if auto follow is enabled

Since:

jcms-9.0.0

addFollower

public void addFollower(Publication pub,
                        Member mbr)

Adds the given member as follower of the given publication.

Parameters:

pub - the publication

mbr - the member

Since:

jcms-7.0.0

removeFollower

public void removeFollower(Publication pub,
                           Member mbr)

Removes the given members from the followers of the given publication.

Parameters:

pub - the publication

mbr - the member

Since:

jcms-7.0.0

removeAllFollowers

public void removeAllFollowers(Publication pub)

Removes all the followers for the given publication.

Parameters:

pub - the publication

Since:

jcms-7.0.0

isFollowed

public boolean isFollowed(Publication pub,
                          Member mbr)

Returns true if the given publication is followed by the given member.

Parameters:

pub - the publication

mbr - the member

Returns:

true if the given publication is followed by the given member.

Since:

jcms-7.0.0

getPublicationFollowerCount

public int getPublicationFollowerCount(Publication pub,
                                       boolean searchParents)

Returns the PublicationFollower count attached to the given publication.

Parameters:

pub - the publication

searchParents - if true search followers of the (TreeNode) parent of this publication

Returns:

the PublicationFollower count attached to the given publication.

Since:

jcms-8.0.1

getPublicationFollowerList

public java.util.List<PublicationFollower> getPublicationFollowerList(Publication pub,
                                                                      boolean searchParents)

Returns the PublicationFollower list attached to the given publication.

Parameters:

pub - the publication

searchParents - if true search followers of the (TreeNode) parent of this publication

Returns:

the PublicationFollower list attached to the given publication.

Since:

jcms-7.0.0

getFollowerList

public java.util.List<Member> getFollowerList(Publication pub,
                                              boolean searchParents)

Returns all the followers of the given publication.

Parameters:

pub - the publication

searchParents - if true search followers of the (TreeNode) parent of this publication

Returns:

all the followers of the given publication.

Since:

jcms-7.0.0

getFollowedPublicationList

public java.util.List<Publication> getFollowedPublicationList(Member mbr)

Returns publications followed by the given member.

Parameters:

mbr - the member

Returns:

publications followed by the given member.

Since:

jcms-7.0.0

canFollow

public boolean canFollow(Member mbr,
                         Publication pub)

Returns true if the given member can follow the given publication.

Parameters:

mbr - the member

pub - the publication

Returns:

true if the given member can follow the given publication.

Since:

jcms-7.0.0

notifyFollowers

public void notifyFollowers(Publication pub,
                            Member opAuthor,
                            java.util.Map context)

Notify all the follower of the given publication.

Parameters:

pub - the publication

opAuthor - the author of the publication's operation which triggered this notification

context - the context used in the publication's operation which triggered this notification

Since:

jcms-7.0.0

notifyFollowers

public void notifyFollowers(Publication pub,
                            Member opAuthor,
                            java.util.Map context,
                            boolean searchParents)

Notify all the follower of the given publication.

Parameters:

pub - the publication

opAuthor - the author of the publication's operation which triggered this notification

context - the context used in the publication's operation which triggered this notification

searchParents - if true search followers of the (TreeNode) parent of this publication

Since:

jcms-8.0.1

notifyFollowers

public void notifyFollowers(Publication pub,
                            Member opAuthor,
                            java.util.Map context,
                            Publication parent)

Notify all the follower of the given publication.

Parameters:

pub - the publication

opAuthor - the author of the publication's operation which triggered this notification

context - the context used in the publication's operation which triggered this notification

parent - the parent Publication of notified pub

Since:

jcms-8.0.1