org.sakaiproject.sitemanage.api

Interface SiteTypeProvider

public interface SiteTypeProvider

This is to allow individual Sakai deployment to add customized site types and logic to apply those to users

Author:

zqian

Method Summary

Modifier and Type	Method and Description
String	getSiteAlias(String type, List<String> params) Construct site alias for certain type
String	getSiteDescription(String type, List<String> params) Construct site title for certain type
String	getSiteShortDescription(String type, List<String> params) Construct site title for certain type
String	getSiteTitle(String type, List<String> params) Construct site title for certain type
HashMap<String,String>	getTemplateForSiteTypes() List of template site for creating certain types of sites
List<String>	getTypes() The whole list of customized types
List<String>	getTypesForSiteCreation() The site types would show up in the site creation list
List<String>	getTypesForSiteList() The site types for site list view

Method Detail

getTypes

List<String> getTypes()

The whole list of customized types

Returns:

getTypesForSiteList

List<String> getTypesForSiteList()

The site types for site list view

Returns:

getTypesForSiteCreation

List<String> getTypesForSiteCreation()

The site types would show up in the site creation list

Returns:

getTemplateForSiteTypes

HashMap<String,String> getTemplateForSiteTypes()

List of template site for creating certain types of sites

Returns:

getSiteTitle

String getSiteTitle(String type,
                    List<String> params)

Construct site title for certain type

Parameters:

type -

params -

Returns:

getSiteDescription

String getSiteDescription(String type,
                          List<String> params)

Construct site title for certain type

Parameters:

type -

params -

Returns:

getSiteShortDescription

String getSiteShortDescription(String type,
                               List<String> params)

Construct site title for certain type

Parameters:

type -

params -

Returns:

getSiteAlias

String getSiteAlias(String type,
                    List<String> params)

Construct site alias for certain type

Parameters:

type -

params -

Returns: