org.sakaiproject.service.legacy.site.cover
Class SiteService

java.lang.Object
  extended byorg.sakaiproject.service.legacy.site.cover.SiteService

public class SiteService
extends Object

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

Version:
$Revision: 5911 $
Author:
University of Michigan, Sakai Software Development Team

Field Summary
static String GROUP_SUBTYPE
           
static String MAIN_CONTAINER
           
static String PAGE_SUBTYPE
           
static String REFERENCE_ROOT
           
static String SECURE_ADD_SITE
           
static String SECURE_ADD_USER_SITE
           
static String SECURE_REMOVE_SITE
           
static String SECURE_UPDATE_SITE
           
static String SECURE_VIEW_ROSTER
           
static String SERVICE_NAME
           
static String SITE_ERROR
           
static String SITE_SUBTYPE
           
static String SITE_TEMPLATE
           
static String SITE_VISIT
           
static String SITE_VISIT_UNPUBLISHED
           
static String TOOL_SUBTYPE
           
static String URL_ERROR
           
static String USER_SITE_TEMPLATE
           
 
Constructor Summary
SiteService()
           
 
Method Summary
static Site addSite(String param0, Site param1)
           
static Site addSite(String param0, String param1)
           
static boolean allowAccessSite(String param0)
           
static boolean allowAddSite(String param0)
           
static boolean allowRemoveSite(String param0)
           
static boolean allowUnjoinSite(String param0)
           
static boolean allowUpdateGroupMembership(String param0)
           
static boolean allowUpdateSite(String param0)
           
static boolean allowUpdateSiteMembership(String param0)
           
static boolean allowViewRoster(String param0)
           
static int countSites(SiteService.SelectionType param0, Object param1, String param2, Map param3)
           
static Group findGroup(String param0)
           
static SitePage findPage(String param0)
           
static ToolConfiguration findTool(String param0)
           
static SiteService getInstance()
          Access the component instance: special cover only method.
static Site getSite(String param0)
           
static String getSiteDisplay(String param0)
           
static List getSites(SiteService.SelectionType param0, Object param1, String param2, Map param3, SiteService.SortType param4, PagingPosition param5)
           
static String getSiteSkin(String param0)
           
static String getSiteSpecialId(String param0)
           
static List getSiteTypes()
           
static String getSiteUserId(String param0)
           
static Site getSiteVisit(String param0)
           
static String getSpecialSiteId(String param0)
           
static String getUserSiteId(String param0)
           
static boolean isSpecialSite(String param0)
           
static boolean isUserSite(String param0)
           
static void join(String param0)
           
static String merge(String param0, Element param1, String param2)
           
static void removeSite(Site param0)
           
static void save(Site param0)
           
static void saveGroupMembership(Site param0)
           
static void saveSiteInfo(String param0, String param1, String param2)
           
static void saveSiteMembership(Site param0)
           
static void setSiteSecurity(String param0, Set param1, Set param2, Set param3)
           
static void setUserSecurity(String param0, Set param1, Set param2, Set param3)
           
static boolean siteExists(String param0)
           
static String siteGroupReference(String param0, String param1)
           
static String sitePageReference(String param0, String param1)
           
static String siteReference(String param0)
           
static String siteToolReference(String param0, String param1)
           
static void unjoin(String param0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SERVICE_NAME

public static String SERVICE_NAME

REFERENCE_ROOT

public static String REFERENCE_ROOT

SITE_VISIT

public static String SITE_VISIT

SITE_VISIT_UNPUBLISHED

public static String SITE_VISIT_UNPUBLISHED

SECURE_ADD_SITE

public static String SECURE_ADD_SITE

SECURE_ADD_USER_SITE

public static String SECURE_ADD_USER_SITE

SECURE_REMOVE_SITE

public static String SECURE_REMOVE_SITE

SECURE_UPDATE_SITE

public static String SECURE_UPDATE_SITE

SECURE_VIEW_ROSTER

public static String SECURE_VIEW_ROSTER

MAIN_CONTAINER

public static String MAIN_CONTAINER

SITE_TEMPLATE

public static String SITE_TEMPLATE

USER_SITE_TEMPLATE

public static String USER_SITE_TEMPLATE

SITE_ERROR

public static String SITE_ERROR

URL_ERROR

public static String URL_ERROR

SITE_SUBTYPE

public static String SITE_SUBTYPE

GROUP_SUBTYPE

public static String GROUP_SUBTYPE

PAGE_SUBTYPE

public static String PAGE_SUBTYPE

TOOL_SUBTYPE

public static String TOOL_SUBTYPE
Constructor Detail

SiteService

public SiteService()
Method Detail

getInstance

public static SiteService getInstance()
Access the component instance: special cover only method.

Returns:
the component instance.

allowAccessSite

public static boolean allowAccessSite(String param0)

getSite

public static Site getSite(String param0)
                    throws IdUnusedException
Throws:
IdUnusedException

siteExists

public static boolean siteExists(String param0)

getSiteVisit

public static Site getSiteVisit(String param0)
                         throws IdUnusedException,
                                PermissionException
Throws:
IdUnusedException
PermissionException

allowUpdateSite

public static boolean allowUpdateSite(String param0)

allowUpdateSiteMembership

public static boolean allowUpdateSiteMembership(String param0)

allowUpdateGroupMembership

public static boolean allowUpdateGroupMembership(String param0)

save

public static void save(Site param0)
                 throws IdUnusedException,
                        PermissionException
Throws:
IdUnusedException
PermissionException

saveSiteMembership

public static void saveSiteMembership(Site param0)
                               throws IdUnusedException,
                                      PermissionException
Throws:
IdUnusedException
PermissionException

saveGroupMembership

public static void saveGroupMembership(Site param0)
                                throws IdUnusedException,
                                       PermissionException
Throws:
IdUnusedException
PermissionException

saveSiteInfo

public static void saveSiteInfo(String param0,
                                String param1,
                                String param2)
                         throws IdUnusedException,
                                PermissionException
Throws:
IdUnusedException
PermissionException

allowAddSite

public static boolean allowAddSite(String param0)

addSite

public static Site addSite(String param0,
                           String param1)
                    throws IdInvalidException,
                           IdUsedException,
                           PermissionException
Throws:
IdInvalidException
IdUsedException
PermissionException

addSite

public static Site addSite(String param0,
                           Site param1)
                    throws IdInvalidException,
                           IdUsedException,
                           PermissionException
Throws:
IdInvalidException
IdUsedException
PermissionException

allowRemoveSite

public static boolean allowRemoveSite(String param0)

removeSite

public static void removeSite(Site param0)
                       throws PermissionException
Throws:
PermissionException

siteReference

public static String siteReference(String param0)

sitePageReference

public static String sitePageReference(String param0,
                                       String param1)

siteToolReference

public static String siteToolReference(String param0,
                                       String param1)

siteGroupReference

public static String siteGroupReference(String param0,
                                        String param1)

isUserSite

public static boolean isUserSite(String param0)

getSiteUserId

public static String getSiteUserId(String param0)

getUserSiteId

public static String getUserSiteId(String param0)

isSpecialSite

public static boolean isSpecialSite(String param0)

getSiteSpecialId

public static String getSiteSpecialId(String param0)

getSpecialSiteId

public static String getSpecialSiteId(String param0)

getSiteDisplay

public static String getSiteDisplay(String param0)

findTool

public static ToolConfiguration findTool(String param0)

findPage

public static SitePage findPage(String param0)

allowViewRoster

public static boolean allowViewRoster(String param0)

unjoin

public static void unjoin(String param0)
                   throws IdUnusedException,
                          PermissionException,
                          InUseException
Throws:
IdUnusedException
PermissionException
InUseException

allowUnjoinSite

public static boolean allowUnjoinSite(String param0)

getSiteSkin

public static String getSiteSkin(String param0)

getSiteTypes

public static List getSiteTypes()

getSites

public static List getSites(SiteService.SelectionType param0,
                            Object param1,
                            String param2,
                            Map param3,
                            SiteService.SortType param4,
                            PagingPosition param5)

countSites

public static int countSites(SiteService.SelectionType param0,
                             Object param1,
                             String param2,
                             Map param3)

setSiteSecurity

public static void setSiteSecurity(String param0,
                                   Set param1,
                                   Set param2,
                                   Set param3)

setUserSecurity

public static void setUserSecurity(String param0,
                                   Set param1,
                                   Set param2,
                                   Set param3)

join

public static void join(String param0)
                 throws IdUnusedException,
                        PermissionException,
                        InUseException
Throws:
IdUnusedException
PermissionException
InUseException

merge

public static String merge(String param0,
                           Element param1,
                           String param2)

findGroup

public static Group findGroup(String param0)