org.sakaiproject.signup.logic

Class SakaiFacadeImpl

java.lang.Object

org.sakaiproject.signup.logic.SakaiFacadeImpl

All Implemented Interfaces:

org.sakaiproject.signup.logic.SakaiFacade

public class SakaiFacadeImpl
extends Object
implements org.sakaiproject.signup.logic.SakaiFacade

This is an implementation of SakaiFacade interface and it provides all necessary methods, which are depend on the Sakai Services. This will allow the separation of Signup Tool and the Sakai Tools

Author:

gl256

Field Summary

Fields inherited from interface org.sakaiproject.signup.logic.SakaiFacade

GROUP_PREFIX, GROUP_PROP_SIGNUP_IGNORE, GROUP_PROP_SITEINFO_VISIBLE, NO_LOCATION, REALM_ID_FOR_LOGIN_REQUIRED_ONLY, SIGNUP_ATTEND, SIGNUP_ATTEND_ALL, SIGNUP_CREATE_GROUP, SIGNUP_CREATE_GROUP_ALL, SIGNUP_CREATE_SITE, SIGNUP_DELETE_GROUP, SIGNUP_DELETE_GROUP_ALL, SIGNUP_DELETE_SITE, SIGNUP_UPDATE_GROUP, SIGNUP_UPDATE_GROUP_ALL, SIGNUP_UPDATE_SITE, SIGNUP_VIEW, SIGNUP_VIEW_ALL, STUDENT_ROLE_ID

Constructor Summary

Constructors

Constructor and Description
SakaiFacadeImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addUsersToGroup(Collection<String> userIds, String siteId, String groupId)
boolean	checkForGroup(String siteId, String groupId)
boolean	checkForUser(String userId)
String	createGroup(String siteId, String title, String description, List<String> userUuids)
List<org.sakaiproject.signup.logic.SignupUser>	getAllPossbileCoordinatorsOnFastTrack(org.sakaiproject.signup.model.SignupMeeting meeting)
List<org.sakaiproject.signup.logic.SignupUser>	getAllPossibleAttendees(org.sakaiproject.signup.model.SignupMeeting meeting)
List<org.sakaiproject.signup.logic.SignupUser>	getAllPossibleCoordinators(org.sakaiproject.signup.model.SignupMeeting meeting)
List<org.sakaiproject.signup.logic.SignupUser>	getAllUsers(org.sakaiproject.signup.model.SignupMeeting meeting)
org.sakaiproject.authz.api.AuthzGroupService	getAuthzGroupService()
org.sakaiproject.calendar.api.Calendar	getCalendar(String siteId)
org.sakaiproject.calendar.api.Calendar	getCalendarById(String calendarId)
org.sakaiproject.content.api.ContentHostingService	getContentHostingService()
String	getCurrentLocationId()
String	getCurrentPageId()
String	getCurrentUserId()
org.sakaiproject.site.api.Group	getGroup(String siteId, String groupId)
List<String>	getGroupMembers(String siteId, String groupId)
String	getLocationTitle(String locationId)
org.sakaiproject.component.api.ServerConfigurationService	getServerConfigurationService()
org.sakaiproject.signup.logic.SignupUser	getSignupUser(org.sakaiproject.signup.model.SignupMeeting meeting, String userId)
org.sakaiproject.site.api.SiteService	getSiteService()
String	getSiteSignupPageId(String siteId)
org.sakaiproject.time.api.TimeService	getTimeService()
org.sakaiproject.tool.api.ToolManager	getToolManager() get the ToolManager object.
org.sakaiproject.user.api.User	getUser(String userId)
org.sakaiproject.user.api.User	getUserByEid(String eid)
org.sakaiproject.user.api.User	getUserByEmail(String email)
String	getUserDisplayLastFirstName(String userId)
String	getUserDisplayName(String userId)
String	getUserId(String eid)
List<String>	getUserPublishedSiteIds(String userId)
org.sakaiproject.user.api.User	getUserQuietly(String userId)
List<org.sakaiproject.user.api.User>	getUsersByEmail(String email)
List<org.sakaiproject.signup.model.SignupSite>	getUserSites(String userId)
List<org.sakaiproject.user.api.User>	getUsersWithPermission(String permission)
boolean	hasPermissionToCreate(org.sakaiproject.signup.model.SignupMeeting meeting, String userId)
void	init() regist all the permission levels, which Signup Tool required.
boolean	isAllowedGroup(String userId, String permission, String siteId, String groupId)
boolean	isAllowedSite(String userId, String permission, String siteId)
boolean	isCsvExportEnabled()
boolean	isUserAdmin(String userId)
void	popSecurityAdvisor(org.sakaiproject.authz.api.SecurityAdvisor advisor)
org.sakaiproject.authz.api.SecurityAdvisor	pushAllowCalendarEdit()
org.sakaiproject.authz.api.SecurityAdvisor	pushSecurityAdvisor()
boolean	removeUserFromGroup(String userId, String siteId, String groupId)
void	setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)
void	setCalendarService(org.sakaiproject.calendar.api.CalendarService calendarService) set a Sakai CalendarService object
void	setContentHostingService(org.sakaiproject.content.api.ContentHostingService contentHostingService) This is a setter.
void	setFunctionManager(org.sakaiproject.authz.api.FunctionManager functionManager) set a Sakai FunctionManager object
void	setSecurityService(org.sakaiproject.authz.api.SecurityService securityService) set a Sakai SecurityService object
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService) set a Sakai ServerConfigurationService object
void	setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager) set a Sakai SessionManager object
void	setSiteService(org.sakaiproject.site.api.SiteService siteService) set a Sakai SiteService object
void	setTimeService(org.sakaiproject.time.api.TimeService timeService) This is a setter.
void	setToolManager(org.sakaiproject.tool.api.ToolManager toolManager) set a Sakai ToolManager object
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService) set a Sakai UserDirectoryService object
boolean	synchonizeGroupTitle(String siteId, String groupId, String newTitle)

Methods inherited from class java.lang.Object

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

Constructor Detail

SakaiFacadeImpl

public SakaiFacadeImpl()

Method Detail

setFunctionManager

public void setFunctionManager(org.sakaiproject.authz.api.FunctionManager functionManager)

set a Sakai FunctionManager object

Parameters:

functionManager - a Sakai FunctionManager object

setToolManager

public void setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)

set a Sakai ToolManager object

Parameters:

toolManager - a Sakai ToolManager object

getToolManager

public org.sakaiproject.tool.api.ToolManager getToolManager()

get the ToolManager object.

Specified by:

getToolManager in interface org.sakaiproject.signup.logic.SakaiFacade

Returns:

a ToolManager object.

setSecurityService

public void setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)

set a Sakai SecurityService object

Parameters:

securityService - a Sakai SecurityService object

setSessionManager

public void setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)

set a Sakai SessionManager object

Parameters:

sessionManager - a Sakai SessionManager object

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

set a Sakai SiteService object

Parameters:

siteService - a Sakai SiteService object

getSiteService

public org.sakaiproject.site.api.SiteService getSiteService()

Specified by:

getSiteService in interface org.sakaiproject.signup.logic.SakaiFacade

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

set a Sakai UserDirectoryService object

Parameters:

userDirectoryService - a Sakai UserDirectoryService object

setCalendarService

public void setCalendarService(org.sakaiproject.calendar.api.CalendarService calendarService)

set a Sakai CalendarService object

Parameters:

calendarService - a Sakai CalendarService object

getServerConfigurationService

public org.sakaiproject.component.api.ServerConfigurationService getServerConfigurationService()

Specified by:

getServerConfigurationService in interface org.sakaiproject.signup.logic.SakaiFacade

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

set a Sakai ServerConfigurationService object

Parameters:

serverConfigurationService - a Sakai ServerConfigurationService object

getAuthzGroupService

public org.sakaiproject.authz.api.AuthzGroupService getAuthzGroupService()

setAuthzGroupService

public void setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)

init

public void init()

regist all the permission levels, which Signup Tool required. Place any code that should run when this class is initialized by spring here

isUserAdmin

public boolean isUserAdmin(String userId)

Specified by:

isUserAdmin in interface org.sakaiproject.signup.logic.SakaiFacade

getCurrentUserId

public String getCurrentUserId()

Specified by:

getCurrentUserId in interface org.sakaiproject.signup.logic.SakaiFacade

getUser

public org.sakaiproject.user.api.User getUser(String userId)

Specified by:

getUser in interface org.sakaiproject.signup.logic.SakaiFacade

getUserQuietly

public org.sakaiproject.user.api.User getUserQuietly(String userId)

Specified by:

getUserQuietly in interface org.sakaiproject.signup.logic.SakaiFacade

checkForUser

public boolean checkForUser(String userId)

Specified by:

checkForUser in interface org.sakaiproject.signup.logic.SakaiFacade

getUserDisplayName

public String getUserDisplayName(String userId)

Specified by:

getUserDisplayName in interface org.sakaiproject.signup.logic.SakaiFacade

getUserDisplayLastFirstName

public String getUserDisplayLastFirstName(String userId)

Specified by:

getUserDisplayLastFirstName in interface org.sakaiproject.signup.logic.SakaiFacade

getCurrentLocationId

public String getCurrentLocationId()

Specified by:

getCurrentLocationId in interface org.sakaiproject.signup.logic.SakaiFacade

getCurrentPageId

public String getCurrentPageId()

Specified by:

getCurrentPageId in interface org.sakaiproject.signup.logic.SakaiFacade

getSiteSignupPageId

public String getSiteSignupPageId(String siteId)

Specified by:

getSiteSignupPageId in interface org.sakaiproject.signup.logic.SakaiFacade

getLocationTitle

public String getLocationTitle(String locationId)

Specified by:

getLocationTitle in interface org.sakaiproject.signup.logic.SakaiFacade

getUserPublishedSiteIds

public List<String> getUserPublishedSiteIds(String userId)

Specified by:

getUserPublishedSiteIds in interface org.sakaiproject.signup.logic.SakaiFacade

getUserSites

public List<org.sakaiproject.signup.model.SignupSite> getUserSites(String userId)

Specified by:

getUserSites in interface org.sakaiproject.signup.logic.SakaiFacade

isAllowedGroup

public boolean isAllowedGroup(String userId,
                     String permission,
                     String siteId,
                     String groupId)

Specified by:

isAllowedGroup in interface org.sakaiproject.signup.logic.SakaiFacade

isAllowedSite

public boolean isAllowedSite(String userId,
                    String permission,
                    String siteId)

Specified by:

isAllowedSite in interface org.sakaiproject.signup.logic.SakaiFacade

getUserId

public String getUserId(String eid)
                 throws org.sakaiproject.user.api.UserNotDefinedException

Specified by:

getUserId in interface org.sakaiproject.signup.logic.SakaiFacade

Throws:

org.sakaiproject.user.api.UserNotDefinedException

getAllUsers

public List<org.sakaiproject.signup.logic.SignupUser> getAllUsers(org.sakaiproject.signup.model.SignupMeeting meeting)

Specified by:

getAllUsers in interface org.sakaiproject.signup.logic.SakaiFacade

getAllPossibleAttendees

public List<org.sakaiproject.signup.logic.SignupUser> getAllPossibleAttendees(org.sakaiproject.signup.model.SignupMeeting meeting)

Specified by:

getAllPossibleAttendees in interface org.sakaiproject.signup.logic.SakaiFacade

getAllPossibleCoordinators

public List<org.sakaiproject.signup.logic.SignupUser> getAllPossibleCoordinators(org.sakaiproject.signup.model.SignupMeeting meeting)

Specified by:

getAllPossibleCoordinators in interface org.sakaiproject.signup.logic.SakaiFacade

getAllPossbileCoordinatorsOnFastTrack

public List<org.sakaiproject.signup.logic.SignupUser> getAllPossbileCoordinatorsOnFastTrack(org.sakaiproject.signup.model.SignupMeeting meeting)

Specified by:

getAllPossbileCoordinatorsOnFastTrack in interface org.sakaiproject.signup.logic.SakaiFacade

getSignupUser

public org.sakaiproject.signup.logic.SignupUser getSignupUser(org.sakaiproject.signup.model.SignupMeeting meeting,
                                                     String userId)

Specified by:

getSignupUser in interface org.sakaiproject.signup.logic.SakaiFacade

getUsersWithPermission

public List<org.sakaiproject.user.api.User> getUsersWithPermission(String permission)

Specified by:

getUsersWithPermission in interface org.sakaiproject.signup.logic.SakaiFacade

hasPermissionToCreate

public boolean hasPermissionToCreate(org.sakaiproject.signup.model.SignupMeeting meeting,
                            String userId)

Specified by:

hasPermissionToCreate in interface org.sakaiproject.signup.logic.SakaiFacade

getCalendar

public org.sakaiproject.calendar.api.Calendar getCalendar(String siteId)
                                                   throws org.sakaiproject.exception.PermissionException

Specified by:

getCalendar in interface org.sakaiproject.signup.logic.SakaiFacade

Throws:

org.sakaiproject.exception.PermissionException

getCalendarById

public org.sakaiproject.calendar.api.Calendar getCalendarById(String calendarId)
                                                       throws org.sakaiproject.exception.PermissionException

Specified by:

getCalendarById in interface org.sakaiproject.signup.logic.SakaiFacade

Throws:

org.sakaiproject.exception.PermissionException

getGroup

public org.sakaiproject.site.api.Group getGroup(String siteId,
                                       String groupId)
                                         throws org.sakaiproject.exception.IdUnusedException

Specified by:

getGroup in interface org.sakaiproject.signup.logic.SakaiFacade

Throws:

org.sakaiproject.exception.IdUnusedException

getTimeService

public org.sakaiproject.time.api.TimeService getTimeService()

Specified by:

getTimeService in interface org.sakaiproject.signup.logic.SakaiFacade

setTimeService

public void setTimeService(org.sakaiproject.time.api.TimeService timeService)

This is a setter.

Parameters:

timeService - a TimeService object.

getContentHostingService

public org.sakaiproject.content.api.ContentHostingService getContentHostingService()

Specified by:

getContentHostingService in interface org.sakaiproject.signup.logic.SakaiFacade

setContentHostingService

public void setContentHostingService(org.sakaiproject.content.api.ContentHostingService contentHostingService)

This is a setter.

Parameters:

contentHostingService - a ContentHostingService object

getUsersByEmail

public List<org.sakaiproject.user.api.User> getUsersByEmail(String email)

Specified by:

getUsersByEmail in interface org.sakaiproject.signup.logic.SakaiFacade

getUserByEmail

public org.sakaiproject.user.api.User getUserByEmail(String email)

Specified by:

getUserByEmail in interface org.sakaiproject.signup.logic.SakaiFacade

getUserByEid

public org.sakaiproject.user.api.User getUserByEid(String eid)

Specified by:

getUserByEid in interface org.sakaiproject.signup.logic.SakaiFacade

isCsvExportEnabled

public boolean isCsvExportEnabled()

Specified by:

isCsvExportEnabled in interface org.sakaiproject.signup.logic.SakaiFacade

pushAllowCalendarEdit

public org.sakaiproject.authz.api.SecurityAdvisor pushAllowCalendarEdit()

Specified by:

pushAllowCalendarEdit in interface org.sakaiproject.signup.logic.SakaiFacade

pushSecurityAdvisor

public org.sakaiproject.authz.api.SecurityAdvisor pushSecurityAdvisor()

Specified by:

pushSecurityAdvisor in interface org.sakaiproject.signup.logic.SakaiFacade

popSecurityAdvisor

public void popSecurityAdvisor(org.sakaiproject.authz.api.SecurityAdvisor advisor)

Specified by:

popSecurityAdvisor in interface org.sakaiproject.signup.logic.SakaiFacade

createGroup

public String createGroup(String siteId,
                 String title,
                 String description,
                 List<String> userUuids)

Specified by:

createGroup in interface org.sakaiproject.signup.logic.SakaiFacade

addUsersToGroup

public boolean addUsersToGroup(Collection<String> userIds,
                      String siteId,
                      String groupId)

Specified by:

addUsersToGroup in interface org.sakaiproject.signup.logic.SakaiFacade

synchonizeGroupTitle

public boolean synchonizeGroupTitle(String siteId,
                           String groupId,
                           String newTitle)

Specified by:

synchonizeGroupTitle in interface org.sakaiproject.signup.logic.SakaiFacade

removeUserFromGroup

public boolean removeUserFromGroup(String userId,
                          String siteId,
                          String groupId)

Specified by:

removeUserFromGroup in interface org.sakaiproject.signup.logic.SakaiFacade

getGroupMembers

public List<String> getGroupMembers(String siteId,
                           String groupId)

Specified by:

getGroupMembers in interface org.sakaiproject.signup.logic.SakaiFacade

checkForGroup

public boolean checkForGroup(String siteId,
                    String groupId)

Specified by:

checkForGroup in interface org.sakaiproject.signup.logic.SakaiFacade