|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Rule
Interface of rules that can be applied on documents by the RuleEngine
Method Summary | |
---|---|
void |
apply(DocumentEvent event)
Execute the rule |
java.lang.String |
getAttribute(java.lang.String strAttributeName)
Gets a specific attribute by its name |
java.lang.String[] |
getAttributesList()
Gives all specific attributes of the rule |
java.lang.String |
getCreateForm(fr.paris.lutece.portal.business.user.AdminUser user,
java.util.Locale locale)
Return the HTML form containing specific fields of the rule |
int |
getId()
Gets the Rule Id |
java.lang.String |
getNameKey()
Gets the Rule name key |
java.lang.String |
getRule()
Gets the Rule definition |
java.lang.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(java.lang.String strAttributeName,
java.lang.String strAttributeValue)
Sets a specific rule attribute |
void |
setId(int nId)
Sets the Rule Id |
void |
setRuleTypeId(java.lang.String strId)
Sets the RuleTypeId |
void |
setUser(fr.paris.lutece.portal.business.user.AdminUser user)
set the admin user who use the rule |
java.lang.String |
validateRule()
Check the rule |
Methods inherited from interface fr.paris.lutece.portal.service.i18n.Localizable |
---|
setLocale |
Method Detail |
---|
void init()
void setId(int nId)
nId
- The rule Idint getId()
void setRuleTypeId(java.lang.String strId)
strId
- The Rule type Idjava.lang.String getRuleTypeId()
java.lang.String getAttribute(java.lang.String strAttributeName)
strAttributeName
- The attribute name
void setAttribute(java.lang.String strAttributeName, java.lang.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 event
DocumentException
- raise when error occurs in event or rulejava.lang.String validateRule()
java.lang.String getCreateForm(fr.paris.lutece.portal.business.user.AdminUser user, java.util.Locale locale)
user
- The current userlocale
- The Locale
java.lang.String[] getAttributesList()
java.lang.String getRule()
fr.paris.lutece.portal.business.user.AdminUser getUser()
boolean isAuthorized(fr.paris.lutece.portal.business.user.AdminUser user)
user
- the current user
void setUser(fr.paris.lutece.portal.business.user.AdminUser user)
user
- the admin user who use the rulejava.lang.String getNameKey()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |