org.alfresco.web.bean.spaces

Class CreateSpaceWizard

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.wizard.BaseWizardBean

org.alfresco.web.bean.spaces.CreateSpaceWizard

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

Direct Known Subclasses:

CreateSpaceDialog

public class CreateSpaceWizard
extends BaseWizardBean

Bean responsible for the create space wizard

Author:

gavinc

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	copyPolicy
protected org.alfresco.service.cmr.repository.NodeRef	createdNode
protected String	createFrom
protected static String	CREATEFROM_EXISTING
protected static String	CREATEFROM_SCRATCH
protected static String	CREATEFROM_TEMPLATE
static String	DEFAULT_SPACE_ICON_NAME
static String	DEFAULT_SPACE_ICON_PATH
static String	DEFAULT_SPACE_TYPE_ICON_PATH
protected String	description
protected org.alfresco.service.cmr.repository.NodeRef	existingSpaceId
protected List<UIDescription>	folderTypeDescriptions
protected List<UIListItem>	folderTypes
protected String	icon
protected String	name
protected boolean	saveAsTemplate
protected String	spaceType
protected String	templateName
protected List<SelectItem>	templates
protected String	templateSpaceId
protected String	title

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

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
CreateSpaceWizard()

Method Summary

Modifier and Type	Method and Description
protected String	finishImpl(FacesContext context, String outcome) Performs the actual processing for the wizard.
protected String	formatErrorMessage(Throwable exception) Formats the error message to display if an error occurs during finish processing
String	getCopyPolicy()
String	getCreateFrom()
String	getDescription()
org.alfresco.service.cmr.repository.NodeRef	getExistingSpaceId()
List<UIDescription>	getFolderTypeDescriptions() Returns a list of UIDescription objects for the folder types
List<UIListItem>	getFolderTypes() Returns a list of UIListItem objects representing the folder types and also constructs the list of descriptions for each type
String	getIcon()
List<UIListItem>	getIcons() Returns a list of icons to allow the user to select from.
String	getName()
String	getSpaceType()
String	getSummary()
String	getTemplateName()
String	getTemplateSpaceId()
List<SelectItem>	getTemplateSpaces()
String	getTitle()
void	init(Map<String,String> parameters) Initialises the wizard
boolean	isSaveAsTemplate()
String	next() Called when the next button is pressed by the user
void	setCopyPolicy(String copyPolicy)
void	setCreateFrom(String createFrom)
void	setDescription(String description)
void	setExistingSpaceId(org.alfresco.service.cmr.repository.NodeRef existingSpaceId)
void	setIcon(String icon)
void	setName(String name)
void	setSaveAsTemplate(boolean saveAsTemplate)
void	setSpaceType(String spaceType)
void	setTemplateName(String templateName)
void	setTemplateSpaceId(String templateSpaceId)
void	setTitle(String title)

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

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

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

cancel, doPostCommitProcessing, finish, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, 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, getFinishButtonDisabled, getMoreActionsConfigId, isFinished, restored

Field Detail

DEFAULT_SPACE_ICON_NAME

public static final String DEFAULT_SPACE_ICON_NAME

See Also:

Constant Field Values

DEFAULT_SPACE_ICON_PATH

public static final String DEFAULT_SPACE_ICON_PATH

See Also:

Constant Field Values

DEFAULT_SPACE_TYPE_ICON_PATH

public static final String DEFAULT_SPACE_TYPE_ICON_PATH

See Also:

Constant Field Values

CREATEFROM_TEMPLATE

protected static final String CREATEFROM_TEMPLATE

See Also:

Constant Field Values

CREATEFROM_EXISTING

protected static final String CREATEFROM_EXISTING

See Also:

Constant Field Values

CREATEFROM_SCRATCH

protected static final String CREATEFROM_SCRATCH

See Also:

Constant Field Values

spaceType

protected String spaceType

icon

protected String icon

createFrom

protected String createFrom

existingSpaceId

protected org.alfresco.service.cmr.repository.NodeRef existingSpaceId

templateSpaceId

protected String templateSpaceId

copyPolicy

protected String copyPolicy

name

protected String name

title

protected String title

description

protected String description

templateName

protected String templateName

saveAsTemplate

protected boolean saveAsTemplate

templates

protected List<SelectItem> templates

folderTypes

protected List<UIListItem> folderTypes

folderTypeDescriptions

protected List<UIDescription> folderTypeDescriptions

createdNode

protected org.alfresco.service.cmr.repository.NodeRef createdNode

Constructor Detail

CreateSpaceWizard

public CreateSpaceWizard()

Method Detail

init

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

Initialises the wizard

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseDialogBean

Parameters:

parameters - Map of parameters for the dialog

next

public String next()

Description copied from interface: IWizardBean

Called when the next button is pressed by the user

Specified by:

next in interface IWizardBean

Overrides:

next in class BaseWizardBean

Returns:

Reserved for future use

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

getCopyPolicy

public String getCopyPolicy()

Returns:

Returns the copyPolicy.

setCopyPolicy

public void setCopyPolicy(String copyPolicy)

Parameters:

copyPolicy - The copyPolicy to set.

getCreateFrom

public String getCreateFrom()

Returns:

Returns the createFrom.

setCreateFrom

public void setCreateFrom(String createFrom)

Parameters:

createFrom - The createFrom to set.

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

getExistingSpaceId

public org.alfresco.service.cmr.repository.NodeRef getExistingSpaceId()

Returns:

Returns the existingSpaceId.

setExistingSpaceId

public void setExistingSpaceId(org.alfresco.service.cmr.repository.NodeRef existingSpaceId)

Parameters:

existingSpaceId - The existingSpaceId to set.

getIcon

public String getIcon()

Returns:

Returns the icon.

setIcon

public void setIcon(String icon)

Parameters:

icon - The icon to set.

getName

public String getName()

Returns:

Returns the name.

setName

public void setName(String name)

Parameters:

name - The name to set.

getTitle

public String getTitle()

Returns:

Returns the title.

setTitle

public void setTitle(String title)

Parameters:

title - The title to set.

isSaveAsTemplate

public boolean isSaveAsTemplate()

Returns:

Returns the saveAsTemplate.

setSaveAsTemplate

public void setSaveAsTemplate(boolean saveAsTemplate)

Parameters:

saveAsTemplate - The saveAsTemplate to set.

getSpaceType

public String getSpaceType()

Returns:

Returns the spaceType.

setSpaceType

public void setSpaceType(String spaceType)

Parameters:

spaceType - The spaceType to set.

getTemplateName

public String getTemplateName()

Returns:

Returns the templateName.

setTemplateName

public void setTemplateName(String templateName)

Parameters:

templateName - The templateName to set.

getTemplateSpaceId

public String getTemplateSpaceId()

Returns:

Returns the templateSpaceId.

setTemplateSpaceId

public void setTemplateSpaceId(String templateSpaceId)

Parameters:

templateSpaceId - The templateSpaceId to set.

getSummary

public String getSummary()

Returns:

Returns the summary data for the wizard.

getTemplateSpaces

public List<SelectItem> getTemplateSpaces()

Returns:

Returns a list of template spaces currently in the system

getFolderTypes

public List<UIListItem> getFolderTypes()

Returns a list of UIListItem objects representing the folder types and also constructs the list of descriptions for each type

Returns:

List of UIListItem components

getFolderTypeDescriptions

public List<UIDescription> getFolderTypeDescriptions()

Returns a list of UIDescription objects for the folder types

Returns:

A list of UIDescription objects

getIcons

public List<UIListItem> getIcons()

Returns a list of icons to allow the user to select from. The list can change according to the type of space being created.

Returns:

A list of icons

formatErrorMessage

protected String formatErrorMessage(Throwable exception)

Formats the error message to display if an error occurs during finish processing

Overrides:

formatErrorMessage in class BaseDialogBean

Parameters:

exception - The exception

Returns:

The formatted message