org.kuali.student.enrollment.class2.autogen.service.impl

Class ARGCourseOfferingManagementViewHelperServiceImpl

java.lang.Object

org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

org.kuali.student.common.uif.service.impl.KSViewHelperServiceImpl

org.kuali.student.enrollment.class2.courseoffering.service.impl.CO_AO_RG_ViewHelperServiceImpl

org.kuali.student.enrollment.class2.autogen.service.impl.ARGCourseOfferingManagementViewHelperServiceImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.krad.uif.service.ViewHelperService, KSViewHelperService, ARGCourseOfferingManagementViewHelperService, CO_AO_RG_ViewHelperService

public class ARGCourseOfferingManagementViewHelperServiceImpl
extends CO_AO_RG_ViewHelperServiceImpl
implements ARGCourseOfferingManagementViewHelperService

This class implements Course offering management functionality using auto-generated registration groups

Author:

Kuali Student Team

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.student.enrollment.class2.courseoffering.service.impl.CO_AO_RG_ViewHelperServiceImpl

roomService, schedulingService, stateService, typeService

Constructor Summary

Constructors

Constructor and Description
ARGCourseOfferingManagementViewHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_performAOCompletePerClusterValidation(List<String> aoTypeKeys, List<ActivityOfferingInfo> aoList, ActivityOfferingClusterWrapper aoClusterWrapper, int clusterIndex, ContextInfo contextInfo) This method will indicate to the user if the cluster canot be generated because the AO Set does not contain enough activities that meet the requirements of the FormatOffering
void	approveActivityOfferings(ARGCourseOfferingManagementForm form)
void	approveCourseOfferings(ARGCourseOfferingManagementForm form)
void	build_AOs_RGs_AOCs_Lists_For_TheCourseOffering(ARGCourseOfferingManagementForm form, CourseOfferingWrapper theCourseOffering) This method fetches, prepares and sets activityWrapperList for View All Activities tab, clusterResultList for View byClusters rgResultList for View Registration Groupsall the course offerings for a term and course/subject code.
void	createActivityOfferings(String formatOfferingId, String activityId, int noOfActivityOfferings, ARGCourseOfferingManagementForm form)
void	deleteCourseOfferings(ARGCourseOfferingManagementForm form)
void	draftActivityOfferings(ARGCourseOfferingManagementForm form)
List<ActivityOfferingWrapper>	getActivityOfferingsByCourseOfferingId(String courseOfferingId, ARGCourseOfferingManagementForm form)
AtpService	getAtpService()
CourseOfferingService	getCourseOfferingService()
CourseService	getCourseService()
static org.kuali.rice.kim.api.identity.IdentityService	getIdentityService()
protected org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults	getInstructorsInfoFromKim(List<String> principalIds)
static LprService	getLprService()
protected LRCService	getLrcService()
SearchService	getSearchService()
CourseOfferingSetService	getSocService()
void	loadActivityOfferingsByCourseOffering(CourseOfferingInfo theCourseOfferingInfo, ARGCourseOfferingManagementForm form)
protected void	loadCourseOfferings(SearchRequestInfo searchRequest, ARGCourseOfferingManagementForm form) This method fetches all the course offerings for a term and course/subject code.
void	loadCourseOfferingsByTermAndCourseCode(String termId, String courseCode, ARGCourseOfferingManagementForm form) This method loads all the course offerings for a term and course code.
void	loadCourseOfferingsByTermAndSubjectCode(String termId, String subjectCode, ARGCourseOfferingManagementForm form) This method loads all the course offerings for a term and subject area/code.
void	loadPreviousAndNextCourseOffering(ARGCourseOfferingManagementForm form) This method loads the previous and next course offerings for navigation purpose.
void	markCourseOfferingsForScheduling(List<CourseOfferingListSectionWrapper> coWrappers, String viewId, String socStateKey, boolean checkedOnly) Notes by Bonnie: The following implementation tries to support "Approve for Scheduling" in two cases historically: 1)when some COs are checked and approve for scheduling link or button is clicked vs.
void	populateTerm(ARGCourseOfferingManagementForm form) This method fetches the TermInfo and validate for exact match
protected void	processAosData(String coId, Map<String,ActivityOfferingClusterWrapper> clusterMap) After the performance improvements, the clusterMap does not contain set information.
protected void	processScheduleRequestsForAos(Collection<String> aoIdsWithoutSch, Map<String,List<ScheduleRequestCalcContainer>> ao2sch, ContextInfo contextInfo) Add scheduling information to the map if there are no "actual" schedules already in place for a particular AO.
TimeSlotInfo	toTimeSlotInfo(ScheduleCalcContainer sched)

Methods inherited from class org.kuali.student.enrollment.class2.courseoffering.service.impl.CO_AO_RG_ViewHelperServiceImpl

convertAOInfoToWrapper, getRoomService, getSchedulingService

Methods inherited from class org.kuali.student.common.uif.service.impl.KSViewHelperServiceImpl

convertServiceExceptionsToUI, createContextInfo, getHelper, getStateInfo, getStateService, getTypeInfo, getTypeService, setHelperClasses

Methods inherited from class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

addCustomContainerComponents, addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getCommonContext, getConfigurationService, getDataDictionaryService, getExpressionEvaluatorService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterAddLine, processAfterDeleteLine, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, retrieveEditModesAndActionFlags, runComponentModifiers, setConfigurationService, setDataDictionaryService, setExpressionEvaluatorService, setViewContext, setViewDictionaryService, syncClientSideStateForComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.student.enrollment.class2.courseoffering.service.CO_AO_RG_ViewHelperService

convertAOInfoToWrapper

Methods inherited from interface org.kuali.student.common.uif.service.KSViewHelperService

convertServiceExceptionsToUI, createContextInfo, getStateInfo, getTypeInfo

Methods inherited from interface org.kuali.rice.krad.uif.service.ViewHelperService

applyDefaultValuesForCollectionLine, buildInquiryLink, cleanViewAfterRender, getCommonContext, performApplyModel, performComponentInitialization, performComponentLifecycle, performFinalize, performInitialization, populateViewFromRequestParameters, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults

Constructor Detail

ARGCourseOfferingManagementViewHelperServiceImpl

public ARGCourseOfferingManagementViewHelperServiceImpl()

Method Detail

populateTerm

public void populateTerm(ARGCourseOfferingManagementForm form)
                  throws Exception

This method fetches the TermInfo and validate for exact match

Specified by:

populateTerm in interface ARGCourseOfferingManagementViewHelperService

Parameters:

form - input ARGCourseOfferingManagementForm

Throws:

Exception

loadCourseOfferingsByTermAndCourseCode

public void loadCourseOfferingsByTermAndCourseCode(String termId,
                                          String courseCode,
                                          ARGCourseOfferingManagementForm form)
                                            throws Exception

This method loads all the course offerings for a term and course code.

Specified by:

loadCourseOfferingsByTermAndCourseCode in interface ARGCourseOfferingManagementViewHelperService

Parameters:

termId - Term Id

courseCode - Course Code

form - Input Form

Throws:

Exception

loadCourseOfferingsByTermAndSubjectCode

public void loadCourseOfferingsByTermAndSubjectCode(String termId,
                                           String subjectCode,
                                           ARGCourseOfferingManagementForm form)
                                             throws Exception

This method loads all the course offerings for a term and subject area/code.

Specified by:

loadCourseOfferingsByTermAndSubjectCode in interface ARGCourseOfferingManagementViewHelperService

Parameters:

termId - term id

subjectCode - subject area

form - course offering management form

Throws:

Exception

build_AOs_RGs_AOCs_Lists_For_TheCourseOffering

public void build_AOs_RGs_AOCs_Lists_For_TheCourseOffering(ARGCourseOfferingManagementForm form,
                                                  CourseOfferingWrapper theCourseOffering)
                                                    throws Exception

This method fetches, prepares and sets activityWrapperList for View All Activities tab, clusterResultList for View byClusters rgResultList for View Registration Groupsall the course offerings for a term and course/subject code.

Specified by:

build_AOs_RGs_AOCs_Lists_For_TheCourseOffering in interface ARGCourseOfferingManagementViewHelperService

Parameters:

form - input form

theCourseOffering - course offering

Throws:

Exception

processScheduleRequestsForAos

protected void processScheduleRequestsForAos(Collection<String> aoIdsWithoutSch,
                                 Map<String,List<ScheduleRequestCalcContainer>> ao2sch,
                                 ContextInfo contextInfo)
                                      throws Exception

Add scheduling information to the map if there are no "actual" schedules already in place for a particular AO.

Parameters:

aoIdsWithoutSch - list of aoIds without schedule information

ao2sch - map of aos to schedules

contextInfo - @throws Exception

Throws:

Exception

processAosData

protected void processAosData(String coId,
                  Map<String,ActivityOfferingClusterWrapper> clusterMap)
                       throws InvalidParameterException,
                              MissingParameterException,
                              DoesNotExistException,
                              PermissionDeniedException,
                              OperationFailedException

After the performance improvements, the clusterMap does not contain set information. So, lets add it here. This method will use the dto to grab a full AOC.

Parameters:

coId - Course Offering Id

clusterMap - map of AoIds to AO cluster wrappers

Throws:

InvalidParameterException

MissingParameterException

DoesNotExistException

PermissionDeniedException

OperationFailedException

getInstructorsInfoFromKim

protected org.kuali.rice.kim.api.identity.entity.EntityDefaultQueryResults getInstructorsInfoFromKim(List<String> principalIds)

_performAOCompletePerClusterValidation

protected void _performAOCompletePerClusterValidation(List<String> aoTypeKeys,
                                          List<ActivityOfferingInfo> aoList,
                                          ActivityOfferingClusterWrapper aoClusterWrapper,
                                          int clusterIndex,
                                          ContextInfo contextInfo)
                                               throws Exception

This method will indicate to the user if the cluster canot be generated because the AO Set does not contain enough activities that meet the requirements of the FormatOffering

Parameters:

aoTypeKeys - list of AO Type Keys

aoList - List Of Activity Offerings

aoClusterWrapper - AO Cluster

clusterIndex - Used to tack the warning message onto a particular part of the screen

contextInfo - context of the call

Throws:

Exception

toTimeSlotInfo

public TimeSlotInfo toTimeSlotInfo(ScheduleCalcContainer sched)

loadCourseOfferings

protected void loadCourseOfferings(SearchRequestInfo searchRequest,
                       ARGCourseOfferingManagementForm form)
                            throws Exception

This method fetches all the course offerings for a term and course/subject code.

Parameters:

searchRequest - search request

form - input form

Throws:

Exception

See Also:

Actual CO search happens here

loadPreviousAndNextCourseOffering

public void loadPreviousAndNextCourseOffering(ARGCourseOfferingManagementForm form)

This method loads the previous and next course offerings for navigation purpose.

Specified by:

loadPreviousAndNextCourseOffering in interface ARGCourseOfferingManagementViewHelperService

Parameters:

form - input form

createActivityOfferings

public void createActivityOfferings(String formatOfferingId,
                           String activityId,
                           int noOfActivityOfferings,
                           ARGCourseOfferingManagementForm form)

Specified by:

createActivityOfferings in interface ARGCourseOfferingManagementViewHelperService

loadActivityOfferingsByCourseOffering

public void loadActivityOfferingsByCourseOffering(CourseOfferingInfo theCourseOfferingInfo,
                                         ARGCourseOfferingManagementForm form)
                                           throws Exception

Specified by:

loadActivityOfferingsByCourseOffering in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

getActivityOfferingsByCourseOfferingId

public List<ActivityOfferingWrapper> getActivityOfferingsByCourseOfferingId(String courseOfferingId,
                                                                   ARGCourseOfferingManagementForm form)
                                                                     throws Exception

Specified by:

getActivityOfferingsByCourseOfferingId in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

approveCourseOfferings

public void approveCourseOfferings(ARGCourseOfferingManagementForm form)
                            throws Exception

Specified by:

approveCourseOfferings in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

deleteCourseOfferings

public void deleteCourseOfferings(ARGCourseOfferingManagementForm form)
                           throws Exception

Specified by:

deleteCourseOfferings in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

approveActivityOfferings

public void approveActivityOfferings(ARGCourseOfferingManagementForm form)
                              throws Exception

Specified by:

approveActivityOfferings in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

draftActivityOfferings

public void draftActivityOfferings(ARGCourseOfferingManagementForm form)
                            throws Exception

Specified by:

draftActivityOfferings in interface ARGCourseOfferingManagementViewHelperService

Throws:

Exception

markCourseOfferingsForScheduling

public void markCourseOfferingsForScheduling(List<CourseOfferingListSectionWrapper> coWrappers,
                                    String viewId,
                                    String socStateKey,
                                    boolean checkedOnly)
                                      throws Exception

Notes by Bonnie: The following implementation tries to support "Approve for Scheduling" in two cases historically: 1)when some COs are checked and approve for scheduling link or button is clicked vs. 2)when a user simply click "Approve Subject Code for Scheduling" link with/without selecting any CO case 1) has been implemented by approveCourseOfferings method -- invoked by Approve button in toolbar case 2) is the only use case when markCourseOfferingsForScheduling is invoked. Therefore the parameter checkedOnly and related checking for each CO seem not needed anymore... TODO: code cleanup??

Examines a List of CourseOffering wrappers and changes the state of each "checked" AO (meaning the CO was selected on the UI) from "Draft" to "Approved". If the AO has a state other than "Draft" the AO is ignored. Also, changes the state of the CourseOffering if appropriate.

Specified by:

markCourseOfferingsForScheduling in interface ARGCourseOfferingManagementViewHelperService

Parameters:

coWrappers, - viewId, socStateKey provides list of CourseOfferings, viewId, socState.

checkedOnly - True if the CO wrapper isChecked() flag should be respected.

Throws:

Exception

getCourseOfferingService

public CourseOfferingService getCourseOfferingService()

Overrides:

getCourseOfferingService in class CO_AO_RG_ViewHelperServiceImpl

getCourseService

public CourseService getCourseService()

getLrcService

protected LRCService getLrcService()

getSearchService

public SearchService getSearchService()

getAtpService

public AtpService getAtpService()

getSocService

public CourseOfferingSetService getSocService()

getIdentityService

public static org.kuali.rice.kim.api.identity.IdentityService getIdentityService()

getLprService

public static LprService getLprService()