|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.processor.BaseProcessorExtension
org.alfresco.repo.jscript.BaseScopableProcessorExtension
org.alfresco.repo.site.script.ScriptSiteService
public class ScriptSiteService
Script object representing the site service.
Field Summary | |
---|---|
static java.lang.String |
MODERATED_SITE
|
static java.lang.String |
PRIVATE_SITE
|
static java.lang.String |
PUBLIC_SITE
Visibility helper constants |
Constructor Summary | |
---|---|
ScriptSiteService()
|
Method Summary | |
---|---|
Site |
createSite(java.lang.String sitePreset,
java.lang.String shortName,
java.lang.String title,
java.lang.String description,
boolean isPublic)
Deprecated. as of version 3.2, replaced by ScriptSiteService.createSite(String, String, String, String, String) |
Site |
createSite(java.lang.String sitePreset,
java.lang.String shortName,
java.lang.String title,
java.lang.String description,
java.lang.String visibility)
Create a new site. |
Site |
getSite(java.lang.String shortName)
Get a site for a provided site short name. |
boolean |
hasCreateSitePermissions()
This method checks if the currently authenticated user has permission to create sites. |
java.lang.String[] |
listSiteRoles()
Returns an array of all the roles that can be assigned to a member of a site. |
Site[] |
listSites(java.lang.String nameFilter,
java.lang.String sitePresetFilter)
List the sites available in the repository. |
Site[] |
listSites(java.lang.String nameFilter,
java.lang.String sitePresetFilter,
int size)
List the sites available in the repository. |
Site[] |
listUserSites(java.lang.String userName)
List all the sites that the specified user has an explicit membership to. |
void |
setServiceRegistry(ServiceRegistry serviceRegistry)
Sets the Service Registry |
void |
setSiteService(SiteService siteService)
Set the site service |
Methods inherited from class org.alfresco.repo.jscript.BaseScopableProcessorExtension |
---|
getScope, setScope |
Methods inherited from class org.alfresco.repo.processor.BaseProcessorExtension |
---|
getExtensionName, register, setExtensionName, setProcessor |
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 PUBLIC_SITE
public static final java.lang.String MODERATED_SITE
public static final java.lang.String PRIVATE_SITE
Constructor Detail |
---|
public ScriptSiteService()
Method Detail |
---|
public void setServiceRegistry(ServiceRegistry serviceRegistry)
serviceRegistry
- public void setSiteService(SiteService siteService)
siteService
- the site servicepublic Site createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, boolean isPublic)
ScriptSiteService.createSite(String, String, String, String, String)
sitePreset
- site presetshortName
- site short nametitle
- site titledescription
- site descriptionisPublic
- whether the site is public or not
#createSite(String, String, String, String, String)}
public Site createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, java.lang.String visibility)
The site short name will be used to uniquely identify the site so it must be unique.
sitePreset
- site presetshortName
- site short nametitle
- site titledescription
- site descriptionvisibility
- visibility of the site (public|moderated|private)
public boolean hasCreateSitePermissions()
true
if the current user is a Contributor to "Sites" node, else false
.public Site[] listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter)
If no filters are specified then all the available sites are returned.
nameFilter
- name filtersitePresetFilter
- site preset filter
public Site[] listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter, int size)
If no filters are specified then all the available sites are returned.
nameFilter
- name filtersitePresetFilter
- site preset filtersize
- max results size crop if >0
public Site[] listUserSites(java.lang.String userName)
userName
- user name
public Site getSite(java.lang.String shortName)
Returns null if the site does not exist.
shortName
- short name of the site
public java.lang.String[] listSiteRoles()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |