Package org.sakaiproject.component.cover

Class ServerConfigurationService

java.lang.Object

org.sakaiproject.component.cover.ServerConfigurationService

public class ServerConfigurationService
extends Object

ServerConfigurationService is a static Cover for the ServerConfigurationService; see that interface for usage details.

Version:

$Revision$

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_PORTAL_PATH
static String	CURRENT_SERVER_URL
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor	Description
ServerConfigurationService()

Method Summary

Modifier and Type	Method	Description
static String	getAccessPath()
static String	getAccessUrl()
static boolean	getBoolean(String param0, boolean param1)
static List	getCategoryGroups(String param0)	Access the list of groups by category (site type)
static List	getDefaultTools(String param0)
static String	getGatewaySiteId()
static String	getHelpUrl(String param0)
static ServerConfigurationService	getInstance()	Access the component instance: special cover only method.
static int	getInt(String param0, int param1)
static String	getLoggedOutUrl()
static String	getPortalUrl()
static String	getSakaiHomePath()
static String	getServerId()
static String	getServerIdInstance()
static String	getServerInstance()
static String	getServerName()
static String	getServerUrl()
static String	getString(String param0)
static String	getString(String param0, String param1)
static String[]	getStrings(String param0)
static List<String>	getToolCategories(String category)	access the list of tool categories for the given site type
static Map<String,List<String>>	getToolCategoriesAsMap(String category)	access the map of tool categories to tool ids for this site type
static List	getToolGroup(String param0)
static List	getToolOrder(String param0)
static List	getToolsRequired(String param0)	Access the list of tools by group
static Map<String,String>	getToolToCategoryMap(String category)	access a map of tool id to tool category id for this site type
static String	getToolUrl()
static String	getUserHomeUrl()
static boolean	toolGroupIsRequired(String param0, String param1)
static boolean	toolGroupIsSelected(String param0, String param1)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT_SERVER_URL

public static final String CURRENT_SERVER_URL

See Also:

Constant Field Values

CURRENT_PORTAL_PATH

public static final String CURRENT_PORTAL_PATH

See Also:

Constant Field Values

SERVICE_NAME

public static String SERVICE_NAME

Constructor Detail

ServerConfigurationService

public ServerConfigurationService()

Method Detail

getInstance

public static ServerConfigurationService getInstance()

Access the component instance: special cover only method.

Returns:

the component instance.

getServerId

public static String getServerId()

getServerInstance

public static String getServerInstance()

getServerIdInstance

public static String getServerIdInstance()

getServerName

public static String getServerName()

getServerUrl

public static String getServerUrl()

getAccessUrl

public static String getAccessUrl()

getAccessPath

public static String getAccessPath()

getHelpUrl

public static String getHelpUrl(String param0)

getPortalUrl

public static String getPortalUrl()

getToolUrl

public static String getToolUrl()

getGatewaySiteId

public static String getGatewaySiteId()

getLoggedOutUrl

public static String getLoggedOutUrl()

getUserHomeUrl

public static String getUserHomeUrl()

getSakaiHomePath

public static String getSakaiHomePath()

getBoolean

public static boolean getBoolean(String param0,
                                 boolean param1)

getString

public static String getString(String param0,
                               String param1)

getString

public static String getString(String param0)

getStrings

public static String[] getStrings(String param0)

getToolOrder

public static List getToolOrder(String param0)

getToolsRequired

public static List getToolsRequired(String param0)

Access the list of tools by group

Parameters:

category - The tool category

Returns:

An unordered list of tool ids (String) in selected group, or an empty list if there are none for this category.

getCategoryGroups

public static List getCategoryGroups(String param0)

Access the list of groups by category (site type)

Parameters:

category - The tool category

Returns:

An ordered list of tool ids (String) indicating the desired tool display order, or an empty list if there are none for this category.

toolGroupIsSelected

public static boolean toolGroupIsSelected(String param0,
                                          String param1)

toolGroupIsRequired

public static boolean toolGroupIsRequired(String param0,
                                          String param1)

getToolGroup

public static List getToolGroup(String param0)

getDefaultTools

public static List getDefaultTools(String param0)

getInt

public static int getInt(String param0,
                         int param1)

getToolCategories

public static List<String> getToolCategories(String category)

access the list of tool categories for the given site type

Parameters:

category - the site type

Returns:

a list of tool category ids in order

getToolCategoriesAsMap

public static Map<String,List<String>> getToolCategoriesAsMap(String category)

access the map of tool categories to tool ids for this site type

Parameters:

category - the site type

Returns:

a map of tool category ids to tool ids

getToolToCategoryMap

public static Map<String,String> getToolToCategoryMap(String category)

access a map of tool id to tool category id for this site type

Parameters:

category - the site type

Returns:

map with tool id as key and category id as value