public interface Rule
extends fr.paris.lutece.portal.service.i18n.Localizable
Modifier and Type | Method and Description |
---|---|
void |
apply(DocumentEvent event)
Execute the rule
|
String |
getAttribute(String strAttributeName)
Gets a specific attribute by its name
|
String[] |
getAttributesList()
Gives all specific attributes of the rule
|
String |
getCreateForm(fr.paris.lutece.portal.business.user.AdminUser user,
Locale locale)
Return the HTML form containing specific fields of the rule
|
int |
getId()
Gets the Rule Id
|
String |
getNameKey()
Gets the Rule name key
|
String |
getRule()
Gets the Rule definition
|
String |
getRuleTypeId()
Gets the Rule Type Id
|
fr.paris.lutece.portal.business.user.AdminUser |
getUser()
Gets the current user
|
void |
init()
Initialize the rule
|
boolean |
isAuthorized(fr.paris.lutece.portal.business.user.AdminUser user)
true if the user is authorized to view the rule
|
void |
readAttributes(javax.servlet.http.HttpServletRequest request)
Reads rule attributes
|
void |
setAttribute(String strAttributeName,
String strAttributeValue)
Sets a specific rule attribute
|
void |
setId(int nId)
Sets the Rule Id
|
void |
setRuleTypeId(String strId)
Sets the RuleTypeId
|
void |
setUser(fr.paris.lutece.portal.business.user.AdminUser user)
set the admin user who use the rule
|
String |
validateRule()
Check the rule
|
void init()
void setId(int nId)
nId
- The rule Idint getId()
void setRuleTypeId(String strId)
strId
- The Rule type IdString getRuleTypeId()
String getAttribute(String strAttributeName)
strAttributeName
- The attribute namevoid setAttribute(String strAttributeName, String strAttributeValue)
strAttributeName
- The attribute namestrAttributeValue
- The attribute valuevoid readAttributes(javax.servlet.http.HttpServletRequest request)
request
- The HTTP requestvoid apply(DocumentEvent event) throws DocumentException
event
- The document eventDocumentException
- raise when error occurs in event or ruleString validateRule()
String getCreateForm(fr.paris.lutece.portal.business.user.AdminUser user, Locale locale)
user
- The current userlocale
- The LocaleString[] getAttributesList()
String getRule()
fr.paris.lutece.portal.business.user.AdminUser getUser()
boolean isAuthorized(fr.paris.lutece.portal.business.user.AdminUser user)
user
- the current uservoid setUser(fr.paris.lutece.portal.business.user.AdminUser user)
user
- the admin user who use the ruleString getNameKey()
Copyright © 2020 City of Paris. All rights reserved.