org.alfresco.repo.site.script
Class ScriptSiteService

java.lang.Object
  org.alfresco.repo.processor.BaseProcessorExtension
      org.alfresco.repo.jscript.BaseScopableProcessorExtension
          org.alfresco.repo.site.script.ScriptSiteService

All Implemented Interfaces:

Scopeable, ProcessorExtension

public class ScriptSiteService
extends BaseScopableProcessorExtension

Script object representing the site service.

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) Create a new site.
Site	getSite(java.lang.String shortName) Get a site for a provided site short name.
java.lang.String[]	listSiteRoles() Returns an array of all the roles that can be assigned to a memeber of a site.
Site[]	listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter) 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

Constructor Detail

ScriptSiteService

public ScriptSiteService()

Method Detail

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the Service Registry

Parameters:

serviceRegistry -

setSiteService

public void setSiteService(SiteService siteService)

Set the site service

Parameters:

siteService - the site service

createSite

public Site createSite(java.lang.String sitePreset,
                       java.lang.String shortName,
                       java.lang.String title,
                       java.lang.String description,
                       boolean isPublic)

Create a new site.

The site short name will be used to uniquely identify the site so it must be unique.

Parameters:

sitePreset - site preset

shortName - site short name

title - site title

description - site description

isPublic - whether the site is public or not

Returns:

Site the created site

listSites

public Site[] listSites(java.lang.String nameFilter,
                        java.lang.String sitePresetFilter)

List the sites available in the repository. The returned list can optionally be filtered by name and site preset.

If no filters are specified then all the available sites are returned.

Parameters:

nameFilter - name filter

sitePresetFilter - site preset filter

Returns:

Site[] a list of the site filtered as appropriate

listUserSites

public Site[] listUserSites(java.lang.String userName)

List all the sites that the specified user has an explicit membership to.

Parameters:

userName - user name

Returns:

Site[] a list of sites the user has an explicit membership to

getSite

public Site getSite(java.lang.String shortName)

Get a site for a provided site short name.

Returns null if the site does not exist.

Parameters:

shortName - short name of the site

Returns:

Site the site, null if does not exist

listSiteRoles

public java.lang.String[] listSiteRoles()

Returns an array of all the roles that can be assigned to a memeber of a site.

Returns:

String[] roles available to assign to a member of a site