fr.paris.lutece.plugins.document.modules.rulenotifyusers.business
Class NotifyUsersRule

java.lang.Object
  extended by fr.paris.lutece.plugins.document.business.rules.AbstractRule
      extended by fr.paris.lutece.plugins.document.modules.rulenotifyusers.business.NotifyUsersRule
All Implemented Interfaces:
Rule, fr.paris.lutece.portal.service.i18n.Localizable

public class NotifyUsersRule
extends AbstractRule

This class provides a rule to notify users on document events


Constructor Summary
NotifyUsersRule()
           
 
Method Summary
 void apply(Document document, fr.paris.lutece.portal.business.user.AdminUser user)
          Apply the rule if conditions are met by the document and the user
 java.lang.String[] getAttributesList()
          Gets all attributes of the rule
 java.lang.String getCreateForm(java.util.Locale locale)
          Gets the Rule create form
 java.lang.String getNameKey()
          Gets the Rule name key
 java.lang.String getRule()
          Gets the explicit text of the rule
 
Methods inherited from class fr.paris.lutece.plugins.document.business.rules.AbstractRule
getAttribute, getId, getLocale, getRuleTypeId, readAttributes, setAttribute, setId, setLocale, setRuleTypeId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NotifyUsersRule

public NotifyUsersRule()
Method Detail

getNameKey

public java.lang.String getNameKey()
Gets the Rule name key

Returns:
The Rule name key

apply

public void apply(Document document,
                  fr.paris.lutece.portal.business.user.AdminUser user)
Apply the rule if conditions are met by the document and the user

Parameters:
document - The document
user - The user

getCreateForm

public java.lang.String getCreateForm(java.util.Locale locale)
Gets the Rule create form

Parameters:
locale - The current locale
Returns:
The HTML form

getAttributesList

public java.lang.String[] getAttributesList()
Gets all attributes of the rule

Returns:
attributes of the rule

getRule

public java.lang.String getRule()
Gets the explicit text of the rule

Returns:
The text of the rule


Copyright © 2007 Mairie de Paris. All Rights Reserved.