WorkspaceWizardContext (JCMS API)

java.lang.Object
- com.jalios.jcms.workspace.WizardContext
- - com.jalios.jcms.workspace.WorkspaceWizardContext

```
public class WorkspaceWizardContext
extends WizardContext
```
This class describes all objects used during a Workspace Wizard deep copy.

Since:

jcms-5.7.3

Version:

$Revision: 63165 $

Author:

Jean-Philippe Encausse

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List`	`adminList`
`protected java.lang.String`	`email`
`protected boolean`	`isCollaborativeSpace`
`protected Workspace`	`parent`
`protected java.util.Map`	`portalMap`
`static java.lang.String`	`REVISION`
`protected java.util.Map<WKRole,WKRole>`	`roleMap`
`protected java.lang.String`	`title`
`protected java.util.Map<java.lang.String,java.lang.String>`	`titleML`
`protected java.util.Collection`	`typeCollec`
`protected Workspace`	`wsmodel`

Fields inherited from class com.jalios.jcms.workspace.WizardContext
append, author, catMap, CONTEXT_WIZARD, cs, ctxt, extraMap, failed, groupMap, prefix, pubMap, trackList, workspace

Constructor Summary

Constructors
Constructor and Description

WorkspaceWizardContext()

Constructors
Constructor and Description
`WorkspaceWizardContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List`	`getAdminList()` Returns the List of administrators of the workspace
`Workspace`	`getParent()` Returns the parent Workspace
`java.util.Map`	`getPortalMap()` Returns a map of old/new Portals used during workspace creation
`java.util.Map<WKRole,WKRole>`	`getRoleMap()` Returns a map of old/new WKRole used during workspace creation
`java.util.Collection`	`getTypeCollection()` Returns a Collection of classes used to filter Workspace Types during workspace creation.
`java.lang.String`	`getWorkspaceId()` Returns the id of the created workspace
`java.lang.String`	`getWSEmail()` Returns a String representing the workspace email
`Workspace`	`getWSModel()` Returns the Workspace model used to deep duplicate
`java.lang.String`	`getWSTitle()` Returns a String representing the new workspace title
`java.util.Map<java.lang.String,java.lang.String>`	`getWSTitleML()` Returns a multilingual Map representing the new workspace titles
`boolean`	`isCollaborativeSpace()` Tell if the creation of ws is in a collaborative space context
`void`	`setAdminList(java.util.List adminList)` Sets the List of administrators of the workspace
`void`	`setCollaborativeSpace(boolean isCollaborativeSpace)`
`void`	`setParent(Workspace parent)` Sets the new parent workspace
`void`	`setPortalMap(java.util.Map portalMap)` Sets a map of old/new Portals used during workspace creation
`void`	`setTypeCollection(java.util.Collection typeCollec)` Sets a Collection of classes used to filter Workspace Types during workspace creation
`void`	`setWSEmail(java.lang.String email)` Sets the new workspace email
`void`	`setWSModel(Workspace wsmodel)` Sets the Workspace model to deep duplicate
`void`	`setWSTitle(java.lang.String title)` Sets the new Wokspace title
`void`	`setWSTitleML(java.util.Map<java.lang.String,java.lang.String> titleML)` Sets the new Wokspace multilingual title

Methods inherited from class com.jalios.jcms.workspace.WizardContext
getAppendPrefix, getAuthor, getCategoryMap, getDataControllerContext, getExtraMap, getFailStatus, getGroupMap, getPrefix, getPublicationMap, getTrackedData, getWorkspace, hasFailed, setAppendPrefix, setAuthor, setCategoryMap, setFailed, setGroupMap, setPrefix, setWorkspace, trackCreatedData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
  - roleMap
```
protected java.util.Map<WKRole,WKRole> roleMap
```
  - portalMap
```
protected java.util.Map portalMap
```
  - wsmodel
```
protected Workspace wsmodel
```
  - adminList
```
protected java.util.List adminList
```
  - title
```
protected java.lang.String title
```
  - titleML
```
protected java.util.Map<java.lang.String,java.lang.String> titleML
```
  - email
```
protected java.lang.String email
```
  - typeCollec
```
protected java.util.Collection typeCollec
```
  - parent
```
protected Workspace parent
```
  - isCollaborativeSpace
```
protected boolean isCollaborativeSpace
```
- Constructor Detail
  - WorkspaceWizardContext
```
public WorkspaceWizardContext()
```
- Method Detail
  - getWorkspaceId
```
public java.lang.String getWorkspaceId()
```
    Returns the id of the created workspace
    
    Returns:
    
    an id of Workspace
    
    Since:
    
    jcms-5.7.3
  - getRoleMap
```
public java.util.Map<WKRole,WKRole> getRoleMap()
```
    Returns a map of old/new WKRole used during workspace creation
    
    Returns:
    
    a Map of old WKRole vs new WKRole
    
    Since:
    
    jcms-5.7.3
  - getTypeCollection
```
public java.util.Collection getTypeCollection()
```
    Returns a Collection of classes used to filter Workspace Types during workspace creation.
    
    Returns:
    
    Collection of classes
    
    Since:
    
    jcms-5.7.3
  - setTypeCollection
```
public void setTypeCollection(java.util.Collection typeCollec)
```
    Sets a Collection of classes used to filter Workspace Types during workspace creation
    
    Parameters:
    
    typeCollec - Set of classes
    
    Since:
    
    jcms-5.7.3
  - getPortalMap
```
public java.util.Map getPortalMap()
```
    Returns a map of old/new Portals used during workspace creation
    
    Returns:
    
    Map of old Portals vs new Portals
    
    Since:
    
    jcms-5.7.3
  - setPortalMap
```
public void setPortalMap(java.util.Map portalMap)
```
    Sets a map of old/new Portals used during workspace creation
    
    Parameters:
    
    portalMap - Map of old Portals vs new Portals
    
    Since:
    
    jcms-5.7.3
  - getWSModel
```
public Workspace getWSModel()
```
    Returns the Workspace model used to deep duplicate
    
    Returns:
    
    wsmodel Workspace model
    
    Since:
    
    jcms-5.7.3
  - setWSModel
```
public void setWSModel(Workspace wsmodel)
```
    Sets the Workspace model to deep duplicate
    
    Parameters:
    
    wsmodel - Workspace model
    
    Since:
    
    jcms-5.7.3
  - getAdminList
```
public java.util.List getAdminList()
```
    Returns the List of administrators of the workspace
    
    Returns:
    
    List of workspace administrators
    
    Since:
    
    jcms-5.7.3
  - setAdminList
```
public void setAdminList(java.util.List adminList)
```
    Sets the List of administrators of the workspace
    
    Parameters:
    
    adminList - List of workspace administrators
    
    Since:
    
    jcms-5.7.3
  - getWSTitle
```
public java.lang.String getWSTitle()
```
    Returns a String representing the new workspace title
    
    Returns:
    
    String the workspace title
    
    Since:
    
    jcms-5.7.3
  - setWSTitle
```
public void setWSTitle(java.lang.String title)
```
    Sets the new Wokspace title
    
    Parameters:
    
    title - String the workspace title
    
    Since:
    
    jcms-5.7.3
  - getWSTitleML
```
public java.util.Map<java.lang.String,java.lang.String> getWSTitleML()
```
    Returns a multilingual Map representing the new workspace titles
    
    Returns:
    
    the multilingual workspace title map
    
    Since:
    
    jcms-9.0.0
  - setWSTitleML
```
public void setWSTitleML(java.util.Map<java.lang.String,java.lang.String> titleML)
```
    Sets the new Wokspace multilingual title
    
    Parameters:
    
    titleML - Map the multilingual workspace titles
    
    Since:
    
    jcms-9.0.0
  - getWSEmail
```
public java.lang.String getWSEmail()
```
    Returns a String representing the workspace email
    
    Returns:
    
    String the email
    
    Since:
    
    jcms-5.7.3
  - setWSEmail
```
public void setWSEmail(java.lang.String email)
```
    Sets the new workspace email
    
    Parameters:
    
    email - String the workspace email
    
    Since:
    
    jcms-5.7.3
  - getParent
```
public Workspace getParent()
```
    Returns the parent Workspace
    
    Returns:
    
    Workspace the parent
    
    Since:
    
    jcms-7.0.0
  - setParent
```
public void setParent(Workspace parent)
```
    Sets the new parent workspace
    
    Parameters:
    
    parent - the parent workspace
    
    Since:
    
    jcms-7.0.0
  - isCollaborativeSpace
```
public boolean isCollaborativeSpace()
```
    Tell if the creation of ws is in a collaborative space context
    
    Returns:
    
    true if it is for a CS
  - setCollaborativeSpace
```
public void setCollaborativeSpace(boolean isCollaborativeSpace)
```
    Parameters:
    
    isCollaborativeSpace - indicates the creation of ws is in a collaborative space context

Class WorkspaceWizardContext

Field Summary

Fields inherited from class com.jalios.jcms.workspace.WizardContext

Constructor Summary

Method Summary

Methods inherited from class com.jalios.jcms.workspace.WizardContext

Methods inherited from class java.lang.Object

Field Detail

REVISION

roleMap

portalMap

wsmodel

adminList

title

titleML

email

typeCollec

parent

isCollaborativeSpace

Constructor Detail

WorkspaceWizardContext

Method Detail

getWorkspaceId

getRoleMap

getTypeCollection

setTypeCollection

getPortalMap

setPortalMap

getWSModel

setWSModel

getAdminList

setAdminList

getWSTitle

setWSTitle

getWSTitleML

setWSTitleML

getWSEmail

setWSEmail

getParent

setParent

isCollaborativeSpace

setCollaborativeSpace