BaseActionWizard (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.bean.dialog.BaseDialogBean
- - org.alfresco.web.bean.wizard.BaseWizardBean
  - - org.alfresco.web.bean.actions.BaseActionWizard

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

Direct Known Subclasses:

CreateRuleWizard, RunActionWizard
```
public abstract class BaseActionWizard
extends BaseWizardBean
```
Base class for the "Run Action" and "Create Rule" wizards.

Author:

gavinc

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseActionWizard.RecipientWrapper
Simple wrapper class for email recipient fields

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseActionWizard.RecipientWrapper` Simple wrapper class for email recipient fields

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`action`
`protected Map<String,IHandler>`	`actionHandlers`
`protected List<SelectItem>`	`actions`
`protected List<SelectItem>`	`addableAspects`
`protected DataModel`	`allActionsDataModel`
`protected List<Map<String,Serializable>>`	`allActionsProperties`
`protected List<SelectItem>`	`commonAspects`
`protected Map<String,Serializable>`	`currentActionProperties`
`protected DataModel`	`currentEmailRecipientsDataModel`
`protected boolean`	`editingAction`
`protected List<SelectItem>`	`encodings`
`protected static String`	`ERROR_ACTION_CANNOT_BE_EXECUTE_REPEATEDLY`
`protected List<SelectItem>`	`imageTransformers`
`protected static String`	`NO_PARAMS_MARKER`
`protected List<SelectItem>`	`objectTypes`
`protected static String`	`PROP_ACTION_EMAIL_RECIPIENTS`
`protected static String`	`PROP_ACTION_NAME`
`protected static String`	`PROP_ACTION_SUMMARY`
`protected List<SelectItem>`	`removableAspects`
`protected String`	`returnViewId`
`protected List<SelectItem>`	`testableAspects`
`protected List<SelectItem>`	`transformers`
`protected List<SelectItem>`	`users`
`protected String`	`usingTemplate`

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean
browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors
Constructor and Description

BaseActionWizard()

Constructors
Constructor and Description
`BaseActionWizard()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction()` Adds the action just setup by the user to the list of actions for the rule
`void`	`addRecipient(ActionEvent event)` Action handler called when the Add button is pressed to add an email recipient
`void`	`cancelAddAction()` Cancels the addition of the action
`void`	`discardTemplate(ActionEvent event)` Action handler called to discard the template from the email body
`String`	`displayLabelForAuthority(String authority)`
`void`	`editAction()` Sets up the context for editing existing action values
`String`	`getAction()`
`Map<String,Serializable>`	`getActionProperties()`
`List<SelectItem>`	`getActions()`
`protected ActionService`	`getActionService()`
`List<SelectItem>`	`getAddableAspects()` Returns a list of aspects that can be added
`DataModel`	`getAllActionsDataModel()` Returns the properties for all the actions as a JSF DataModel
`protected AuthorityService`	`getAuthorityService()`
`protected List<SelectItem>`	`getCommonAspects()` Returns the aspects that are available in all scenarios i.e.
`List<BaseActionWizard.RecipientWrapper>`	`getEmailRecipients(Map<String,Serializable> actionProperties)` Returns the current list of email recipients
`DataModel`	`getEmailRecipientsDataModel()` Returns the properties for email recipients JSF DataModel
`List<SelectItem>`	`getImageTransformers()` Returns the image transformers that are available
`protected org.alfresco.service.cmr.repository.MimetypeService`	`getMimetypeService()`
`List<SelectItem>`	`getObjectTypes()`
`protected PersonService`	`getPersonService()`
`List<SelectItem>`	`getRemovableAspects()` Returns a list of aspects that can be removed
`List<SelectItem>`	`getTestableAspects()` Returns a list of aspects that can be tested i.e.
`List<SelectItem>`	`getTransformers()` Returns the transformers that are available
`List<SelectItem>`	`getUsers()`
`String`	`getUsingTemplate()`
`protected void`	`goToPage(FacesContext context, String viewId)` Navigates to the given page, used to go back and forth between the wizard and the actions settings pages
`void`	`init(Map<String,String> parameters)` Initialises the dialog bean
`protected void`	`initialiseActionHandlers()` Initialises the action handlers from the current configuration.
`void`	`insertTemplate(ActionEvent event)` Action handler called to insert a template as the email body
`protected boolean`	`isActionPresent(String actionName)`
`boolean`	`isFinishButtonDisabled()`
`void`	`promptForActionValues()` Displays the settings page for the current action being added
`protected List<SelectItem>`	`readAspectsConfig(FacesContext context, org.springframework.extensions.config.ConfigElement aspectsCfg)`
`void`	`removeAction()` Removes the requested action from the list
`void`	`removeRecipient(ActionEvent event)` Action handler called when the Remove icon is pressed to remove an email recipient
`void`	`setAction(String action)`
`void`	`setActionService(ActionService actionService)` Sets the action service
`void`	`setAuthorityService(AuthorityService authorityService)`
`void`	`setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)` Sets the mimetype service
`void`	`setPersonService(PersonService personService)`
`void`	`setUsingTemplate(String usingTemplate)`

Methods inherited from class org.alfresco.web.bean.wizard.BaseWizardBean
back, buildSummary, getBackButtonLabel, getDefaultCancelOutcome, getDefaultFinishOutcome, getFinishButtonLabel, getNextButtonDisabled, getNextButtonLabel, getStepDescription, getStepTitle, next

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, getFinishButtonDisabled, getMoreActionsConfigId, isFinished, restored

- Field Detail
  - PROP_ACTION_NAME
```
protected static final String PROP_ACTION_NAME
```
    See Also:
    
    Constant Field Values
  - PROP_ACTION_SUMMARY
```
protected static final String PROP_ACTION_SUMMARY
```
    See Also:
    
    Constant Field Values
  - PROP_ACTION_EMAIL_RECIPIENTS
```
protected static final String PROP_ACTION_EMAIL_RECIPIENTS
```
    See Also:
    
    Constant Field Values
  - NO_PARAMS_MARKER
```
protected static final String NO_PARAMS_MARKER
```
    See Also:
    
    Constant Field Values
  - ERROR_ACTION_CANNOT_BE_EXECUTE_REPEATEDLY
```
protected static final String ERROR_ACTION_CANNOT_BE_EXECUTE_REPEATEDLY
```
    See Also:
    
    Constant Field Values
  - actions
```
protected List<SelectItem> actions
```
  - transformers
```
protected List<SelectItem> transformers
```
  - imageTransformers
```
protected List<SelectItem> imageTransformers
```
  - commonAspects
```
protected List<SelectItem> commonAspects
```
  - removableAspects
```
protected List<SelectItem> removableAspects
```
  - addableAspects
```
protected List<SelectItem> addableAspects
```
  - testableAspects
```
protected List<SelectItem> testableAspects
```
  - users
```
protected List<SelectItem> users
```
  - encodings
```
protected List<SelectItem> encodings
```
  - objectTypes
```
protected List<SelectItem> objectTypes
```
  - allActionsDataModel
```
protected transient DataModel allActionsDataModel
```
  - currentEmailRecipientsDataModel
```
protected transient DataModel currentEmailRecipientsDataModel
```
  - editingAction
```
protected boolean editingAction
```
  - action
```
protected String action
```
  - usingTemplate
```
protected String usingTemplate
```
  - returnViewId
```
protected String returnViewId
```
  - currentActionProperties
```
protected Map<String,Serializable> currentActionProperties
```
  - allActionsProperties
```
protected List<Map<String,Serializable>> allActionsProperties
```
  - actionHandlers
```
protected Map<String,IHandler> actionHandlers
```
- Constructor Detail
  - BaseActionWizard
```
public BaseActionWizard()
```
- 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 BaseDialogBean
    
    Parameters:
    
    parameters - Map of parameters for the dialog
  - getAction
```
public String getAction()
```
    Returns:
    
    Returns the selected action
  - setAction
```
public void setAction(String action)
```
    Parameters:
    
    action - Sets the selected action
  - getUsingTemplate
```
public String getUsingTemplate()
```
    Returns:
    
    Returns if a template has been inserted by a user for email body.
  - setUsingTemplate
```
public void setUsingTemplate(String usingTemplate)
```
    Parameters:
    
    usingTemplate - Template that has been inserted by a user for the email body.
  - getAllActionsDataModel
```
public DataModel getAllActionsDataModel()
```
    Returns the properties for all the actions as a JSF DataModel
    
    Returns:
    
    JSF DataModel representing the action properties
  - getEmailRecipientsDataModel
```
public DataModel getEmailRecipientsDataModel()
```
    Returns the properties for email recipients JSF DataModel
    
    Returns:
    
    JSF DataModel wrapping the current email recipients
  - getActionProperties
```
public Map<String,Serializable> getActionProperties()
```
    Returns:
    
    Gets the action settings
  - getActions
```
public List<SelectItem> getActions()
```
    Returns:
    
    Returns the list of selectable actions
  - getRemovableAspects
```
public List<SelectItem> getRemovableAspects()
```
    Returns a list of aspects that can be removed
    
    Returns:
    
    List of SelectItem objects representing the aspects that can be removed
  - getAddableAspects
```
public List<SelectItem> getAddableAspects()
```
    Returns a list of aspects that can be added
    
    Returns:
    
    List of SelectItem objects representing the aspects that can be added
  - getTestableAspects
```
public List<SelectItem> getTestableAspects()
```
    Returns a list of aspects that can be tested i.e. hasAspect
    
    Returns:
    
    List of SelectItem objects representing the aspects that can be tested for
  - getObjectTypes
```
public List<SelectItem> getObjectTypes()
```
    Returns:
    
    Returns a list of object types to allow the user to select from
  - getUsers
```
public List<SelectItem> getUsers()
```
    Returns:
    
    the List of users in the system wrapped in SelectItem objects
  - getTransformers
```
public List<SelectItem> getTransformers()
```
    Returns the transformers that are available
    
    Returns:
    
    List of SelectItem objects representing the available transformers
  - getImageTransformers
```
public List<SelectItem> getImageTransformers()
```
    Returns the image transformers that are available
    
    Returns:
    
    List of SelectItem objects representing the available image transformers
  - getEmailRecipients
```
public List<BaseActionWizard.RecipientWrapper> getEmailRecipients(Map<String,Serializable> actionProperties)
```
    Returns the current list of email recipients
    
    Returns:
    
    List of email recipients
  - promptForActionValues
```
public void promptForActionValues()
```
    Displays the settings page for the current action being added
  - editAction
```
public void editAction()
```
    Sets up the context for editing existing action values
  - addAction
```
public void addAction()
```
    Adds the action just setup by the user to the list of actions for the rule
  - removeAction
```
public void removeAction()
```
    Removes the requested action from the list
  - cancelAddAction
```
public void cancelAddAction()
```
    Cancels the addition of the action
  - addRecipient
```
public void addRecipient(ActionEvent event)
```
    Action handler called when the Add button is pressed to add an email recipient
  - removeRecipient
```
public void removeRecipient(ActionEvent event)
```
    Action handler called when the Remove icon is pressed to remove an email recipient
  - insertTemplate
```
public void insertTemplate(ActionEvent event)
```
    Action handler called to insert a template as the email body
  - discardTemplate
```
public void discardTemplate(ActionEvent event)
```
    Action handler called to discard the template from the email body
  - setActionService
```
public void setActionService(ActionService actionService)
```
    Sets the action service
    
    Parameters:
    
    actionService - the action service
  - getActionService
```
protected ActionService getActionService()
```
  - setMimetypeService
```
public void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
```
    Sets the mimetype service
    
    Parameters:
    
    mimetypeService - The mimetype service
  - getMimetypeService
```
protected org.alfresco.service.cmr.repository.MimetypeService getMimetypeService()
```
  - setPersonService
```
public void setPersonService(PersonService personService)
```
    Parameters:
    
    personService - The personService to set.
  - getPersonService
```
protected PersonService getPersonService()
```
  - setAuthorityService
```
public void setAuthorityService(AuthorityService authorityService)
```
    Parameters:
    
    authorityService - The authorityService to set.
  - getAuthorityService
```
protected AuthorityService getAuthorityService()
```
  - displayLabelForAuthority
```
public String displayLabelForAuthority(String authority)
```
  - goToPage
```
protected void goToPage(FacesContext context,
                        String viewId)
```
    Navigates to the given page, used to go back and forth between the wizard and the actions settings pages
    
    Parameters:
    
    context - FacesContext
    
    viewId - The viewId to go to
  - initialiseActionHandlers
```
protected void initialiseActionHandlers()
```
    Initialises the action handlers from the current configuration.
  - getCommonAspects
```
protected List<SelectItem> getCommonAspects()
```
    Returns the aspects that are available in all scenarios i.e. add, remove and test
    
    Returns:
    
    List of SelectItem objects representing the available aspects
  - readAspectsConfig
```
protected List<SelectItem> readAspectsConfig(FacesContext context,
                                             org.springframework.extensions.config.ConfigElement aspectsCfg)
```
  - isFinishButtonDisabled
```
public boolean isFinishButtonDisabled()
```
  - isActionPresent
```
protected boolean isActionPresent(String actionName)
```

Class BaseActionWizard

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ACTION_NAME

PROP_ACTION_SUMMARY

PROP_ACTION_EMAIL_RECIPIENTS

NO_PARAMS_MARKER

ERROR_ACTION_CANNOT_BE_EXECUTE_REPEATEDLY

actions

transformers

imageTransformers

commonAspects

removableAspects

addableAspects

testableAspects

users

encodings

objectTypes

allActionsDataModel

currentEmailRecipientsDataModel

editingAction

action

usingTemplate

returnViewId

currentActionProperties

allActionsProperties

actionHandlers

Constructor Detail

BaseActionWizard

Method Detail

init

getAction

setAction

getUsingTemplate

setUsingTemplate

getAllActionsDataModel

getEmailRecipientsDataModel

getActionProperties

getActions

getRemovableAspects

getAddableAspects

getTestableAspects

getObjectTypes

getUsers

getTransformers

getImageTransformers

getEmailRecipients

promptForActionValues

editAction

addAction

removeAction

cancelAddAction

addRecipient

removeRecipient

insertTemplate

discardTemplate

setActionService

getActionService

setMimetypeService

getMimetypeService

setPersonService

getPersonService

setAuthorityService

getAuthorityService

displayLabelForAuthority

goToPage

initialiseActionHandlers

getCommonAspects

readAspectsConfig

isFinishButtonDisabled

isActionPresent