org.kuali.student.enrollment.class2.courseoffering.helper.impl

Class ActivityOfferingScheduleHelperImpl

java.lang.Object

org.kuali.student.enrollment.class2.courseoffering.helper.impl.ActivityOfferingScheduleHelperImpl

All Implemented Interfaces:

ActivityOfferingScheduleHelper

public class ActivityOfferingScheduleHelperImpl
extends Object
implements ActivityOfferingScheduleHelper

This is a helper class for handling all the schedule related logics in Activity Offering Maintenance document. The reason behind having a helper class is, as the scheduling is going to be a complex system and also it involves external scheduler, this would allow the institutions to just refactor/enhance the scheduling logic without affecting the other logic in Activity Offering Maintenance document.

Author:

Kuali Student Team

Constructor Summary

Constructors

Constructor and Description
ActivityOfferingScheduleHelperImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addScheduleRequestComponent(ActivityOfferingWrapper activityOfferingWrapper)
protected void	buildScheduleWrapper(ActivityOfferingWrapper wrapper, ScheduleWrapper scheduleWrapper, ScheduleRequestComponentInfo componentInfo, ContextInfo defaultContextInfo)
protected ContextInfo	createContextInfo()
void	deleteRequestedAndActualSchedules(ScheduleRequestSetInfo schSet, String activityId, List<String> deleteScheduleIds, ContextInfo defaultContextInfo)
TimeSlotInfo	fetchOrCreateTimeSlot(ActivityOfferingWrapper aoWrapper, ScheduleWrapper scheduleWrapper, ContextInfo defaultContextInfo)
List<String>	getEndTimes(String days, String startTime, String timeSlotType) This method retrieves a list of matching end times for days and startime entered by the user.
protected void	loadColocatedAOs(ActivityOfferingWrapper wrapper, ScheduleWrapper scheduleWrapper)
void	loadScheduleRequests(ActivityOfferingWrapper wrapper, ContextInfo defaultContextInfo) This method loads the schedule requests/components.
void	loadSchedules(ActivityOfferingWrapper wrapper, ContextInfo defaultContextInfo)
void	loadSchedulesAndComponents(ActivityOfferingWrapper wrapper, ContextInfo defaultContextInfo)
List<BuildingInfo>	retrieveBuildingInfoByCode(String buildingCode) Searches for buildings given a building code.
List<BuildingInfo>	retrieveBuildingInfoByCode(String buildingCode, boolean strictMatch) Searches for buildings given a building code.
void	savePostMSE(ActivityOfferingWrapper activityOfferingWrapper, ContextInfo defaultContextInfo)
void	savePreMSE(ActivityOfferingWrapper wrapper, ContextInfo contextInfo)
void	saveSchedules(ActivityOfferingWrapper wrapper, ContextInfo defaultContextInfo)
protected ActivityOfferingInfo	updateScheduledActivityOffering(ActivityOfferingInfo activityOfferingInfo, ContextInfo context)
protected boolean	validateNewScheduleRequest(ScheduleWrapper scheduleWrapper)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityOfferingScheduleHelperImpl

public ActivityOfferingScheduleHelperImpl()

Method Detail

saveSchedules

@Transactional
public void saveSchedules(ActivityOfferingWrapper wrapper,
                               ContextInfo defaultContextInfo)

Specified by:

saveSchedules in interface ActivityOfferingScheduleHelper

loadSchedules

public void loadSchedules(ActivityOfferingWrapper wrapper,
                 ContextInfo defaultContextInfo)

Specified by:

loadSchedules in interface ActivityOfferingScheduleHelper

savePostMSE

public void savePostMSE(ActivityOfferingWrapper activityOfferingWrapper,
               ContextInfo defaultContextInfo)

addScheduleRequestComponent

public boolean addScheduleRequestComponent(ActivityOfferingWrapper activityOfferingWrapper)

validateNewScheduleRequest

protected boolean validateNewScheduleRequest(ScheduleWrapper scheduleWrapper)

savePreMSE

public void savePreMSE(ActivityOfferingWrapper wrapper,
              ContextInfo contextInfo)

fetchOrCreateTimeSlot

public TimeSlotInfo fetchOrCreateTimeSlot(ActivityOfferingWrapper aoWrapper,
                                 ScheduleWrapper scheduleWrapper,
                                 ContextInfo defaultContextInfo)
                                   throws Exception

Throws:

Exception

loadScheduleRequests

public void loadScheduleRequests(ActivityOfferingWrapper wrapper,
                        ContextInfo defaultContextInfo)

This method loads the schedule requests/components. Support multiple schedule requests

Parameters:

wrapper - ActivityOfferingWrapper

buildScheduleWrapper

protected void buildScheduleWrapper(ActivityOfferingWrapper wrapper,
                        ScheduleWrapper scheduleWrapper,
                        ScheduleRequestComponentInfo componentInfo,
                        ContextInfo defaultContextInfo)

loadColocatedAOs

protected void loadColocatedAOs(ActivityOfferingWrapper wrapper,
                    ScheduleWrapper scheduleWrapper)

loadSchedulesAndComponents

public void loadSchedulesAndComponents(ActivityOfferingWrapper wrapper,
                              ContextInfo defaultContextInfo)

updateScheduledActivityOffering

protected ActivityOfferingInfo updateScheduledActivityOffering(ActivityOfferingInfo activityOfferingInfo,
                                                   ContextInfo context)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               DoesNotExistException,
                                                               PermissionDeniedException,
                                                               OperationFailedException,
                                                               DataValidationErrorException,
                                                               ReadOnlyException,
                                                               VersionMismatchException

Throws:

InvalidParameterException

MissingParameterException

DoesNotExistException

PermissionDeniedException

OperationFailedException

DataValidationErrorException

ReadOnlyException

VersionMismatchException

deleteRequestedAndActualSchedules

public void deleteRequestedAndActualSchedules(ScheduleRequestSetInfo schSet,
                                     String activityId,
                                     List<String> deleteScheduleIds,
                                     ContextInfo defaultContextInfo)

createContextInfo

protected ContextInfo createContextInfo()

retrieveBuildingInfoByCode

public List<BuildingInfo> retrieveBuildingInfoByCode(String buildingCode,
                                            boolean strictMatch)
                                              throws Exception

Searches for buildings given a building code.

Parameters:

buildingCode - A building code.

strictMatch - If false do a wildcard search matching at the beginning of the field. Otherwise, match exactly.

Returns:

A List of BuildingInfos

Throws:

Exception

retrieveBuildingInfoByCode

public List<BuildingInfo> retrieveBuildingInfoByCode(String buildingCode)
                                              throws Exception

Searches for buildings given a building code.

Parameters:

buildingCode - A building code.

Returns:

A List of BuildingInfos

Throws:

Exception

getEndTimes

public List<String> getEndTimes(String days,
                       String startTime,
                       String timeSlotType)
                         throws Exception

This method retrieves a list of matching end times for days and startime entered by the user. This loads only the standard timeslots.

Specified by:

getEndTimes in interface ActivityOfferingScheduleHelper

Parameters:

days -

startTime -

timeSlotType -

Returns:

Throws:

Exception