com.jalios.jcms.policy

Class BasicPublicationFollowerPolicyFilter

java.lang.Object

com.jalios.jcms.policy.AbstractPolicyFilter

com.jalios.jcms.policy.BasicPublicationFollowerPolicyFilter

All Implemented Interfaces:

PluginComponent, PolicyFilter, PublicationFollowerPolicyFilter, java.lang.Comparable

public class BasicPublicationFollowerPolicyFilter
extends AbstractPolicyFilter
implements PublicationFollowerPolicyFilter, PluginComponent

Field Summary

Fields

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

Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

order

Constructor Summary

Constructors

Constructor and Description
BasicPublicationFollowerPolicyFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canFollow(Member mbr, Publication pub) Returns true if the given member can follow the given publication.
boolean	init(Plugin plugin) Initialize the component with the given plugin configuration
boolean	searchParents(boolean searchParents, Publication pub, java.util.Map context) Returns true if the notification should be sent to PublicationFollower of parent of the Publication
boolean	sendFollowerNotification(Member mbr, Publication pub, java.util.Map context) Returns true if the notification for the given publication must be sent to the given member
boolean	sendFollowerNotification(Publication pub, java.util.Map context) Returns true if the notification must be sent to the follower of the given publication

Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

compareTo, equals, getOrder, setOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

BasicPublicationFollowerPolicyFilter

public BasicPublicationFollowerPolicyFilter()

Method Detail

init

public boolean init(Plugin plugin)

Description copied from interface: PluginComponent

Initialize the component with the given plugin configuration

Specified by:

init in interface PluginComponent

Parameters:

plugin - the calling plugin

Returns:

true if the component has been correctly initialized.

canFollow

public boolean canFollow(Member mbr,
                Publication pub)

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

Specified by:

canFollow in interface PublicationFollowerPolicyFilter

Parameters:

mbr - the member

pub - the publication

Returns:

true if the given member can follow the given publication.

Since:

jcms-7.0.0

sendFollowerNotification

public boolean sendFollowerNotification(Publication pub,
                               java.util.Map context)

Returns true if the notification must be sent to the follower of the given publication

Specified by:

sendFollowerNotification in interface PublicationFollowerPolicyFilter

Parameters:

pub - the publication

context - the DataController context

Returns:

true if the notification must be sent to the follower of the given publication

Since:

jcms-7.0.0

sendFollowerNotification

public boolean sendFollowerNotification(Member mbr,
                               Publication pub,
                               java.util.Map context)

Returns true if the notification for the given publication must be sent to the given member

Specified by:

sendFollowerNotification in interface PublicationFollowerPolicyFilter

Parameters:

mbr - the member

pub - the publication

context - the DataController context

Returns:

true if the notification for the given publication must be sent to the given member

Since:

jcms-7.0.0

searchParents

public boolean searchParents(boolean searchParents,
                    Publication pub,
                    java.util.Map context)

Returns true if the notification should be sent to PublicationFollower of parent of the Publication

Specified by:

searchParents in interface PublicationFollowerPolicyFilter

Parameters:

searchParents - the current searchParents value

pub - the publication

context - the DataController context

Returns:

true if the notification should be sent to PublicationFollower of parent of the Publication

Since:

jcms-8.0.1