fr.paris.lutece.plugins.document.modules.rulemovespace.business
Class MoveSpaceRule

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

public class MoveSpaceRule
extends AbstractRule

This rule lets move a document from a space to another when the document's state is changing


Constructor Summary
MoveSpaceRule()
           
 
Method Summary
 void apply(Document document, fr.paris.lutece.portal.business.user.AdminUser user)
          Method invoked by the RuleEngine
 java.lang.String[] getAttributesList()
          Gets all attributes of the rule
 java.lang.String getCreateForm(java.util.Locale locale)
          Gets a specific form to enter rule's attributes
 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

MoveSpaceRule

public MoveSpaceRule()
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)
Method invoked by the RuleEngine

Parameters:
document - The document concerned by the rule
user - The user of the action

getCreateForm

public java.lang.String getCreateForm(java.util.Locale locale)
Gets a specific form to enter rule's attributes

Parameters:
locale - The current Locale
Returns:
The HTML code of the 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.