|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.wcm.webproject.script.WebProject
public class WebProject
WebProject object to expose via JavaScript
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 |
---|
public static final java.lang.String ROLE_CONTENT_MANAGER
public static final java.lang.String ROLE_CONTENT_PUBLISHER
public static final java.lang.String ROLE_CONTENT_REVIEWER
public static final java.lang.String ROLE_CONTENT_CONTRIBUTOR
Constructor Detail |
---|
public WebProject(WebProjects webprojects, WebProjectInfo info)
Method Detail |
---|
public void setName(java.lang.String name)
public java.lang.String getName()
public void setTitle(java.lang.String title)
public java.lang.String getTitle()
public void setDescription(java.lang.String description)
public java.lang.String getDescription()
public void setTemplate(boolean isTemplate)
public boolean isTemplate()
public void setWebProjectRef(java.lang.String webProjectRef)
public java.lang.String getWebProjectRef()
public org.alfresco.service.cmr.repository.NodeRef getNodeRef()
public void deleteWebProject()
public void save()
public ScriptableHashMap getSandboxes(java.lang.String userName)
userName
-
public Sandbox createSandbox(java.lang.String userName)
userName
-
public Sandbox getSandbox(java.lang.String sandboxRef)
sandboxRef
-
public ScriptableHashMap getSandboxes()
public java.lang.String getMembersRole(java.lang.String userName)
If the user is not a member of the site then null is returned.
userName
- user name
public void addMembership(java.lang.String userName, java.lang.String role)
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.
userName
- user namerole
- site rolepublic void removeMembership(java.lang.String userName)
userName
- user namepublic ScriptableHashMap listMembers()
public ScriptableHashMap getRoles()
public WebProjects getWebProjects()
public SandboxService getSandboxService()
public WebProjectService getWebProjectService()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |