org.alfresco.wcm.webproject.script
Class WebProject

java.lang.Object
  extended by org.alfresco.wcm.webproject.script.WebProject
All Implemented Interfaces:
java.io.Serializable

public class WebProject
extends java.lang.Object
implements java.io.Serializable

WebProject object to expose via JavaScript

See Also:
Serialized Form

Field Summary
static java.lang.String ROLE_CONTENT_CONTRIBUTOR
           
static java.lang.String ROLE_CONTENT_MANAGER
           
static java.lang.String ROLE_CONTENT_PUBLISHER
           
static java.lang.String ROLE_CONTENT_REVIEWER
           
 
Constructor Summary
WebProject(WebProjects webprojects, WebProjectInfo info)
           
 
Method Summary
 void addMembership(java.lang.String userName, java.lang.String role)
          Sets the membership details for a user.
 Sandbox createSandbox(java.lang.String userName)
          Create a user sandbox, if the user already has a sandbox does nothing.
 void deleteWebProject()
          delete this web project
 java.lang.String getDescription()
           
 java.lang.String getMembersRole(java.lang.String userName)
          Gets a user's role on this site.
 java.lang.String getName()
           
 org.alfresco.service.cmr.repository.NodeRef getNodeRef()
           
 ScriptableHashMap getRoles()
          List the role (name) for a WCM project
 Sandbox getSandbox(java.lang.String sandboxRef)
          Get a single sandbox by its unique reference
 ScriptableHashMap getSandboxes()
          getSandboxes for this web project
 ScriptableHashMap getSandboxes(java.lang.String userName)
          getSandboxes
 SandboxService getSandboxService()
           
 java.lang.String getTitle()
           
 java.lang.String getWebProjectRef()
           
 WebProjects getWebProjects()
           
 WebProjectService getWebProjectService()
           
 boolean isTemplate()
           
 ScriptableHashMap listMembers()
          Gets a map of members of the web project with their role within the web project.
 void removeMembership(java.lang.String userName)
          Removes a users membership of the web project.
 void save()
          update this web project
 void setDescription(java.lang.String description)
           
 void setName(java.lang.String name)
           
 void setTemplate(boolean isTemplate)
           
 void setTitle(java.lang.String title)
           
 void setWebProjectRef(java.lang.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 java.lang.String ROLE_CONTENT_MANAGER
See Also:
Constant Field Values

ROLE_CONTENT_PUBLISHER

public static final java.lang.String ROLE_CONTENT_PUBLISHER
See Also:
Constant Field Values

ROLE_CONTENT_REVIEWER

public static final java.lang.String ROLE_CONTENT_REVIEWER
See Also:
Constant Field Values

ROLE_CONTENT_CONTRIBUTOR

public static final java.lang.String ROLE_CONTENT_CONTRIBUTOR
See Also:
Constant Field Values
Constructor Detail

WebProject

public WebProject(WebProjects webprojects,
                  WebProjectInfo info)
Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setTemplate

public void setTemplate(boolean isTemplate)

isTemplate

public boolean isTemplate()

setWebProjectRef

public void setWebProjectRef(java.lang.String webProjectRef)

getWebProjectRef

public java.lang.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 getSandboxes(java.lang.String userName)
getSandboxes

Parameters:
userName -
Returns:
the sandboxes or an empty map if there are none.

createSandbox

public Sandbox createSandbox(java.lang.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(java.lang.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 getSandboxes()
getSandboxes for this web project

Returns:
the sandboxes

getMembersRole

public java.lang.String getMembersRole(java.lang.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(java.lang.String userName,
                          java.lang.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(java.lang.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 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 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()


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.