org.alfresco.wcm.webproject.script

Class WebProject

java.lang.Object

org.alfresco.wcm.webproject.script.WebProject

All Implemented Interfaces:

Serializable

public class WebProject
extends Object
implements Serializable

WebProject object to expose via JavaScript

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE_CONTENT_CONTRIBUTOR
static String	ROLE_CONTENT_MANAGER
static String	ROLE_CONTENT_PUBLISHER
static String	ROLE_CONTENT_REVIEWER

Constructor Summary

Constructors

Constructor and Description
WebProject(WebProjects webprojects, WebProjectInfo info)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMembership(String userName, String role) Sets the membership details for a user.
Sandbox	createSandbox(String userName) Create a user sandbox, if the user already has a sandbox does nothing.
void	deleteWebProject() delete this web project
String	getDescription()
String	getMembersRole(String userName) Gets a user's role on this site.
String	getName()
org.alfresco.service.cmr.repository.NodeRef	getNodeRef()
ScriptableHashMap<String,String>	getRoles() List the role (name) for a WCM project
Sandbox	getSandbox(String sandboxRef) Get a single sandbox by its unique reference
ScriptableHashMap<String,Sandbox>	getSandboxes() getSandboxes for this web project
ScriptableHashMap<String,Sandbox>	getSandboxes(String userName) getSandboxes
SandboxService	getSandboxService()
String	getTitle()
String	getWebProjectRef()
WebProjects	getWebProjects()
WebProjectService	getWebProjectService()
boolean	isTemplate()
ScriptableHashMap<String,String>	listMembers() Gets a map of members of the web project with their role within the web project.
void	removeMembership(String userName) Removes a users membership of the web project.
void	save() update this web project
void	setDescription(String description)
void	setName(String name)
void	setTemplate(boolean isTemplate)
void	setTemplate(Boolean isTemplate)
void	setTitle(String title)
void	setWebProjectRef(String webProjectRef)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_CONTENT_MANAGER

public static final String ROLE_CONTENT_MANAGER

See Also:

Constant Field Values

ROLE_CONTENT_PUBLISHER

public static final String ROLE_CONTENT_PUBLISHER

See Also:

Constant Field Values

ROLE_CONTENT_REVIEWER

public static final String ROLE_CONTENT_REVIEWER

See Also:

Constant Field Values

ROLE_CONTENT_CONTRIBUTOR

public static final String ROLE_CONTENT_CONTRIBUTOR

See Also:

Constant Field Values

Constructor Detail

WebProject

public WebProject(WebProjects webprojects,
          WebProjectInfo info)

Method Detail

setName

public void setName(String name)

getName

public String getName()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

setTemplate

public void setTemplate(boolean isTemplate)

setTemplate

public void setTemplate(Boolean isTemplate)

isTemplate

public boolean isTemplate()

setWebProjectRef

public void setWebProjectRef(String webProjectRef)

getWebProjectRef

public String getWebProjectRef()

getNodeRef

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

deleteWebProject

public void deleteWebProject()

delete this web project

save

public void save()

update this web project

getSandboxes

public ScriptableHashMap<String,Sandbox> getSandboxes(String userName)

getSandboxes

Parameters:

userName -

Returns:

the sandboxes or an empty map if there are none.

createSandbox

public Sandbox createSandbox(String userName)

Create a user sandbox, if the user already has a sandbox does nothing.

Parameters:

userName -

Returns:

the newly created sandbox details

getSandbox

public Sandbox getSandbox(String sandboxRef)

Get a single sandbox by its unique reference

Parameters:

sandboxRef -

Returns:

the sandbox or null if it is not found.

getSandboxes

public ScriptableHashMap<String,Sandbox> getSandboxes()

getSandboxes for this web project

Returns:

the sandboxes

getMembersRole

public String getMembersRole(String userName)

Gets a user's role on this site.

If the user is not a member of the site then null is returned.

Parameters:

userName - user name

Returns:

String user's role or null if not a member

addMembership

public void addMembership(String userName,
                 String role)

Sets the membership details for a user.

If the user is not already a member of the web project then they are invited with the role given.

Only a content manager can modify memberships and there must be at least one conttent manager at all times.

Parameters:

userName - user name

role - site role

removeMembership

public void removeMembership(String userName)

Removes a users membership of the web project. Note: this will cascade delete the user's sandboxes without warning (even if there are modified items)

Parameters:

userName - user name

listMembers

public ScriptableHashMap<String,String> listMembers()

Gets a map of members of the web project with their role within the web project.

Returns:

ScriptableHashMap list of members of site with their roles

getRoles

public ScriptableHashMap<String,String> getRoles()

List the role (name) for a WCM project

Returns:

a map of roles for a WCM project (value, name)

getWebProjects

public WebProjects getWebProjects()

getSandboxService

public SandboxService getSandboxService()

getWebProjectService

public WebProjectService getWebProjectService()