org.alfresco.web.bean.rules

Class CreateRuleWizard

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.wizard.BaseWizardBean

org.alfresco.web.bean.actions.BaseActionWizard

org.alfresco.web.bean.rules.CreateRuleWizard

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

Direct Known Subclasses:

CreateCompositeRuleWizard

public class CreateRuleWizard
extends BaseActionWizard

Bean implementation for the "Create Rule" wizard

Author:

gavinc

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.web.bean.actions.BaseActionWizard

BaseActionWizard.RecipientWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected DataModel	allConditionsDataModel
protected List<Map<String,Serializable>>	allConditionsPropertiesList
protected boolean	applyToSubSpaces
protected Map<String,IHandler>	conditionHandlers
protected Map<String,Serializable>	currentConditionProperties
protected String	description
protected boolean	editingCondition
protected static String	PROP_CONDITION_NAME
protected static String	PROP_CONDITION_SUMMARY
protected boolean	ruleDisabled
protected RulesDialog	rulesDialog
protected boolean	runInBackground
protected String	selectedCondition
protected String	title
protected String	type

Fields inherited from class org.alfresco.web.bean.actions.BaseActionWizard

action, actionHandlers, actions, addableAspects, allActionsDataModel, allActionsProperties, commonAspects, currentActionProperties, currentEmailRecipientsDataModel, editingAction, encodings, ERROR_ACTION_CANNOT_BE_EXECUTE_REPEATEDLY, imageTransformers, NO_PARAMS_MARKER, objectTypes, PROP_ACTION_EMAIL_RECIPIENTS, PROP_ACTION_NAME, PROP_ACTION_SUMMARY, removableAspects, returnViewId, testableAspects, transformers, users, usingTemplate

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
CreateRuleWizard()

Method Summary

Modifier and Type	Method and Description
void	addCondition() Adds the condition just setup by the user to the list of conditions for the rule
void	cancelAddCondition() Cancels the addition of the condition
void	editCondition() Sets up the context for editing existing condition values
protected void	editCondition(Map conditionToEdit)
protected String	finishImpl(FacesContext context, String outcome) Performs the actual processing for the wizard.
DataModel	getAllConditionsDataModel() Returns the properties for all the conditions as a JSF DataModel
boolean	getApplyToSubSpaces()
protected CompositeAction	getCompositeAction(Rule rule)
String	getCondition()
Map<String,Serializable>	getConditionProperties()
List<SelectItem>	getConditions()
String	getDescription()
protected String	getErrorMessageId() The default message id to use in error messages
boolean	getFinishButtonDisabled() Determines whether the finish button on the dialog should be disabled
List<SelectItem>	getMimeTypes() Returns a list of mime types in the system
List<SelectItem>	getModelTypes() Returns a list of the types available in the repository
boolean	getNextButtonDisabled() Determines whether the next button on the wizard should be disabled
boolean	getRuleDisabled()
protected RuleService	getRuleService() Get the rule service
boolean	getRuleTypeDisabled() Determines whether the rule type drop down list should be enabled.
boolean	getRunInBackground()
String	getSummary()
String	getTitle()
String	getType()
List<SelectItem>	getTypes()
void	init(Map<String,String> parameters) Initialises the dialog bean
protected void	initialiseConditionHandlers() Initialises the condition handlers from the current configuration.
void	promptForConditionValues() Displays the settings page for the current condition being added (if required)
void	removeCondition() Removes the requested condition from the list
void	setApplyToSubSpaces(boolean applyToSubSpaces)
void	setCondition(String condition)
void	setDescription(String description)
void	setRuleDisabled(boolean ruleDisabled)
void	setRulesDialog(RulesDialog RulesDialog) Sets the rulesDialog instance to be used by the wizard in edit mode
void	setRuleService(RuleService ruleService)
void	setRunInBackground(boolean runInBackground)
void	setTitle(String title)
void	setType(String type)
protected String	setupRule(FacesContext context, Rule rule, String outcome) Sets up the given rule using the current state of the wizard

Methods inherited from class org.alfresco.web.bean.actions.BaseActionWizard

addAction, addRecipient, cancelAddAction, discardTemplate, displayLabelForAuthority, editAction, getAction, getActionProperties, getActions, getActionService, getAddableAspects, getAllActionsDataModel, getAuthorityService, getCommonAspects, getEmailRecipients, getEmailRecipientsDataModel, getImageTransformers, getMimetypeService, getObjectTypes, getPersonService, getRemovableAspects, getTestableAspects, getTransformers, getUsers, getUsingTemplate, goToPage, initialiseActionHandlers, insertTemplate, isActionPresent, isFinishButtonDisabled, promptForActionValues, readAspectsConfig, removeAction, removeRecipient, setAction, setActionService, setAuthorityService, setMimetypeService, setPersonService, setUsingTemplate

Methods inherited from class org.alfresco.web.bean.wizard.BaseWizardBean

back, buildSummary, getBackButtonLabel, getDefaultCancelOutcome, getDefaultFinishOutcome, getFinishButtonLabel, getNextButtonLabel, getStepDescription, getStepTitle, next

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDictionaryService, getErrorOutcome, getFileFolderService, getMoreActionsConfigId, getNamespaceService, getNodeService, getSearchService, getTransactionService, isFinished, restored, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.web.bean.dialog.IDialogBean

cancel, finish, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getContainerDescription, getContainerSubTitle, getContainerTitle, getMoreActionsConfigId, isFinished, restored

Field Detail

PROP_CONDITION_NAME

protected static final String PROP_CONDITION_NAME

See Also:

Constant Field Values

PROP_CONDITION_SUMMARY

protected static final String PROP_CONDITION_SUMMARY

See Also:

Constant Field Values

rulesDialog

protected RulesDialog rulesDialog

conditionHandlers

protected Map<String,IHandler> conditionHandlers

currentConditionProperties

protected Map<String,Serializable> currentConditionProperties

allConditionsDataModel

protected transient DataModel allConditionsDataModel

allConditionsPropertiesList

protected List<Map<String,Serializable>> allConditionsPropertiesList

title

protected String title

description

protected String description

type

protected String type

selectedCondition

protected String selectedCondition

runInBackground

protected boolean runInBackground

applyToSubSpaces

protected boolean applyToSubSpaces

editingCondition

protected boolean editingCondition

ruleDisabled

protected boolean ruleDisabled

Constructor Detail

CreateRuleWizard

public CreateRuleWizard()

Method Detail

init

public void init(Map<String,String> parameters)

Description copied from interface: IDialogBean

Initialises the dialog bean

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseActionWizard

Parameters:

parameters - Map of parameters for the dialog

finishImpl

protected String finishImpl(FacesContext context,
                            String outcome)
                     throws Exception

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Exception

getNextButtonDisabled

public boolean getNextButtonDisabled()

Description copied from interface: IWizardBean

Determines whether the next button on the wizard should be disabled

Specified by:

getNextButtonDisabled in interface IWizardBean

Overrides:

getNextButtonDisabled in class BaseWizardBean

Returns:

true if the button should be disabled

getFinishButtonDisabled

public boolean getFinishButtonDisabled()

Description copied from interface: IDialogBean

Determines whether the finish button on the dialog should be disabled

Specified by:

getFinishButtonDisabled in interface IDialogBean

Overrides:

getFinishButtonDisabled in class BaseDialogBean

Returns:

true if the button should be disabled

getSummary

public String getSummary()

Returns:

Returns the summary data for the wizard.

getErrorMessageId

protected String getErrorMessageId()

Description copied from class: BaseDialogBean

The default message id to use in error messages

Overrides:

getErrorMessageId in class BaseDialogBean

Returns:

The error message lookup id

getCompositeAction

protected CompositeAction getCompositeAction(Rule rule)

getRuleTypeDisabled

public boolean getRuleTypeDisabled()

Determines whether the rule type drop down list should be enabled.

Returns:

false as the rule type drop down should be enabled

getAllConditionsDataModel

public DataModel getAllConditionsDataModel()

Returns the properties for all the conditions as a JSF DataModel

Returns:

JSF DataModel representing the condition properties

getModelTypes

public List<SelectItem> getModelTypes()

Returns a list of the types available in the repository

Returns:

List of SelectItem objects

getMimeTypes

public List<SelectItem> getMimeTypes()

Returns a list of mime types in the system

Returns:

List of mime types

getConditions

public List<SelectItem> getConditions()

Returns:

Returns the list of selectable conditions

getTypes

public List<SelectItem> getTypes()

Returns:

Returns the types of rules that can be defined

getConditionProperties

public Map<String,Serializable> getConditionProperties()

Returns:

Gets the condition settings

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

getTitle

public String getTitle()

Returns:

Returns the title.

setTitle

public void setTitle(String title)

Parameters:

title - The title to set.

getRunInBackground

public boolean getRunInBackground()

Returns:

Returns whether the rule should run in the background

setRunInBackground

public void setRunInBackground(boolean runInBackground)

Parameters:

runInBackground - Sets whether the rule should run in the background

getApplyToSubSpaces

public boolean getApplyToSubSpaces()

Returns:

Returns whether the rule should be applied to sub spaces i.e. if it gets inherited

setApplyToSubSpaces

public void setApplyToSubSpaces(boolean applyToSubSpaces)

Parameters:

applyToSubSpaces - Sets whether the rule will get applied to sub spaces

getRuleDisabled

public boolean getRuleDisabled()

Returns:

Returns whether the rule is disabled or not.

setRuleDisabled

public void setRuleDisabled(boolean ruleDisabled)

Parameters:

ruleDisabled - Sets whether the rule is disabled or not

getType

public String getType()

Returns:

Returns the type.

setType

public void setType(String type)

Parameters:

type - The type to set

getCondition

public String getCondition()

Returns:

Returns the selected condition

setCondition

public void setCondition(String condition)

Parameters:

condition - Sets the selected condition

promptForConditionValues

public void promptForConditionValues()

Displays the settings page for the current condition being added (if required)

editCondition

public void editCondition()

Sets up the context for editing existing condition values

editCondition

protected void editCondition(Map conditionToEdit)

addCondition

public void addCondition()

Adds the condition just setup by the user to the list of conditions for the rule

removeCondition

public void removeCondition()

Removes the requested condition from the list

cancelAddCondition

public void cancelAddCondition()

Cancels the addition of the condition

setRuleService

public void setRuleService(RuleService ruleService)

Parameters:

ruleService - Sets the rule service to use

getRuleService

protected RuleService getRuleService()

Description copied from class: BaseDialogBean

Get the rule service

Overrides:

getRuleService in class BaseDialogBean

Returns:

RuleService rule service

setRulesDialog

public void setRulesDialog(RulesDialog RulesDialog)

Sets the rulesDialog instance to be used by the wizard in edit mode

Parameters:

RulesDialog - The rulesDialog

setupRule

protected String setupRule(FacesContext context,
                           Rule rule,
                           String outcome)

Sets up the given rule using the current state of the wizard

Parameters:

context - FacesContext

rule - The rule to setup

outcome - The default outcome

Returns:

The outcome

initialiseConditionHandlers

protected void initialiseConditionHandlers()

Initialises the condition handlers from the current configuration.