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

Class CourseOfferingCreateMaintainableImpl

java.lang.Object

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

org.kuali.rice.krad.maintenance.MaintainableImpl

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

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

All Implemented Interfaces:

Serializable, Maintainable, ViewHelperService

public class CourseOfferingCreateMaintainableImpl
extends CourseOfferingMaintainableImpl
implements Maintainable

View helper service to deal with all the create course offering presentation.

See Also:

CourseOfferingCreateController, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CourseOfferingCreateMaintainableImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormatOffering(CourseOfferingCreateWrapper wrapper) Adds a format offering.
protected static String	convertCourseFinalExamTypeToCourseOfferingFinalExamType(String courseFinalExamType) Services needs to come up with a standard way to represent final exams.
void	copyJointFormatOfferings(CourseOfferingCreateWrapper wrapper) This method copies all the selected joint format offerings and creates format offering for the main course as well as for the selected joint courses.
protected CourseOfferingInfo	createCourseOfferingInfo(String termId, CourseInfo courseInfo, String courseOfferingSuffix, CourseOfferingInfo courseOffering) This method creates the CourseOffering for a course and for a specific term.
protected void	createFormatOfferings(CourseOfferingCreateWrapper wrapper) This method creates format offerings for all the format selected by the user.
protected void	createJointCOs(CourseOfferingCreateWrapper wrapper) This method creates all the Course Offerings for joint courses.
FormatInfo	getMatchingFormatInfo(CourseInfo courseInfoToSearch, FormatInfo formatInfoToMatchWith) This method iterates all the FormatInfo in a CourseInfo to match with the passed it FormatInfo.
void	loadCourseJointInfos(CourseOfferingCreateWrapper wrapper, String viewId) This method loads the wrapper details for the joint courses
void	processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters) Sets a default maintenace document description and if term code exists in the request parameter, set it to the wrapper.
void	processCollectionDeleteLine(View view, Object model, String collectionPath, int lineIndex) This is overridden from KRAD to implement deleting the format from the joint courses.
List<String>	retrieveCourseCodes(String targetTermCode, String catalogCourseCode) The premise of this is rather simple.
void	saveDataObject() Overrides from KRAD to handle saving the DTOs

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

collectActivityTypeKeyValues, getFormatShortAndLongNames, getTypeName, loadCrossListedCOs, populateFinalExamDriverTypes, populateFormatNames, populateGradeRosterLevelTypes, processAfterDeleteLine, processCollectionAddBlankLine

Methods inherited from class org.kuali.rice.krad.maintenance.MaintainableImpl

deleteDataObject, doRouteStatusChange, generateMaintenanceLocks, getCustomLockDescriptor, getDataObject, getDataObjectAuthorizationService, getDataObjectClass, getDataObjectMetaDataService, getDocumentDictionaryService, getDocumentNumber, getDocumentTitle, getDocumentTypeName, getEncryptionService, getLockingDocumentId, getLookupService, getMaintenanceAction, getMaintenanceDocumentService, getPersistableBusinessObject, getWorkflowEngineDocumentIdsToLock, isExternalBusinessObject, isLockable, isNotesEnabled, isOldDataObjectInDocument, prepareExternalBusinessObject, prepareForSave, processAfterAddLine, processAfterCopy, processAfterEdit, processAfterPost, processAfterRetrieve, retrieveObjectForEditOrCopy, setDataObject, setDataObjectAuthorizationService, setDataObjectClass, setDataObjectMetaDataService, setDocumentDictionaryService, setDocumentNumber, setEncryptionService, setLookupService, setMaintenanceAction, setMaintenanceDocumentService, setupNewFromExisting, useCustomLockDescriptors

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

addCustomContainerComponents, addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildExportTableData, buildExportTableRow, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getBusinessObjectService, getCommonContext, getConfigurationService, getDataDictionaryService, getExportTableFormatOptions, getExpressionEvaluator, getPersistenceService, getPersistenceStructureService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, retrieveEditModesAndActionFlags, runComponentModifiers, setBusinessObjectService, setConfigurationService, setDataDictionaryService, setExpressionEvaluator, setPersistenceService, setPersistenceStructureService, setViewContext, setViewDictionaryService, spawnSubLifecyle, 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.rice.krad.maintenance.Maintainable

deleteDataObject, doRouteStatusChange, generateMaintenanceLocks, getCustomLockDescriptor, getDataObject, getDataObjectClass, getDocumentTitle, getLockingDocumentId, getMaintenanceAction, getPersistableBusinessObject, getWorkflowEngineDocumentIdsToLock, isExternalBusinessObject, isLockable, isNotesEnabled, isOldDataObjectInDocument, prepareExternalBusinessObject, prepareForSave, processAfterCopy, processAfterEdit, processAfterPost, processAfterRetrieve, retrieveObjectForEditOrCopy, setDataObject, setDataObjectClass, setDocumentNumber, setMaintenanceAction, setupNewFromExisting, useCustomLockDescriptors

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

applyDefaultValuesForCollectionLine, buildExportTableData, buildInquiryLink, cleanViewAfterRender, getCommonContext, getExpressionEvaluator, performApplyModel, performComponentInitialization, performComponentLifecycle, performFinalize, performInitialization, populateViewFromRequestParameters, processCollectionAddBlankLine, processCollectionAddLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, spawnSubLifecyle

Constructor Detail

CourseOfferingCreateMaintainableImpl

public CourseOfferingCreateMaintainableImpl()

Method Detail

processAfterNew

public void processAfterNew(MaintenanceDocument document,
                   Map<String,String[]> requestParameters)

Sets a default maintenace document description and if term code exists in the request parameter, set it to the wrapper. When 'Create CO' is called from manage co screen, we pass in the term code.

Specified by:

processAfterNew in interface Maintainable

Overrides:

processAfterNew in class MaintainableImpl

saveDataObject

public void saveDataObject()

Overrides from KRAD to handle saving the DTOs

Specified by:

saveDataObject in interface Maintainable

Overrides:

saveDataObject in class MaintainableImpl

createCourseOfferingInfo

protected CourseOfferingInfo createCourseOfferingInfo(String termId,
                                          CourseInfo courseInfo,
                                          String courseOfferingSuffix,
                                          CourseOfferingInfo courseOffering)
                                               throws Exception

This method creates the CourseOffering for a course and for a specific term. This is being called for the regular CO as well as for the Joint offerings

Parameters:

termId - courseing offering created for this term

courseInfo - this is the course info for which this mehtod is going to create course offering

courseOfferingSuffix - the suffix entered by the user

Returns:

created course offering

Throws:

Exception - throws any of the services exception from the service call

convertCourseFinalExamTypeToCourseOfferingFinalExamType

protected static String convertCourseFinalExamTypeToCourseOfferingFinalExamType(String courseFinalExamType)

Services needs to come up with a standard way to represent final exams.

Parameters:

courseFinalExamType - course final exam type

Returns:

CO final exam type

createFormatOfferings

protected void createFormatOfferings(CourseOfferingCreateWrapper wrapper)

This method creates format offerings for all the format selected by the user. As the CourseOfferingCreateWrapper.formatOfferingWrappers list holds all the formats for the joint courses as well (just to display the list at the ui), this method skips those formats here.

Parameters:

wrapper - CourseOfferingCreateWrapper

createJointCOs

protected void createJointCOs(CourseOfferingCreateWrapper wrapper)
                       throws Exception

This method creates all the Course Offerings for joint courses.

Parameters:

wrapper - CourseOfferingCreateWrapper

Throws:

Exception

loadCourseJointInfos

public void loadCourseJointInfos(CourseOfferingCreateWrapper wrapper,
                        String viewId)
                          throws Exception

This method loads the wrapper details for the joint courses

Parameters:

wrapper - CourseOfferingCreateWrapper

Throws:

Exception - throws one of the services exceptions

addFormatOffering

public void addFormatOffering(CourseOfferingCreateWrapper wrapper)

Adds a format offering. This handles creating format offerings for all the selected joint courses as well.

copyJointFormatOfferings

public void copyJointFormatOfferings(CourseOfferingCreateWrapper wrapper)

This method copies all the selected joint format offerings and creates format offering for the main course as well as for the selected joint courses.

Parameters:

wrapper - course offering wrapper

processCollectionDeleteLine

public void processCollectionDeleteLine(View view,
                               Object model,
                               String collectionPath,
                               int lineIndex)

This is overridden from KRAD to implement deleting the format from the joint courses. It should not be a problem overriding this method completely as we dont need any validation or pre/post event for this action

Specified by:

processCollectionDeleteLine in interface ViewHelperService

Overrides:

processCollectionDeleteLine in class ViewHelperServiceImpl

getMatchingFormatInfo

public FormatInfo getMatchingFormatInfo(CourseInfo courseInfoToSearch,
                               FormatInfo formatInfoToMatchWith)

This method iterates all the FormatInfo in a CourseInfo to match with the passed it FormatInfo.

There is no id match here. It simply iterates all the formats and match the activities count and type. If all the activity types matches, it returns that FormatInfo

Parameters:

courseInfoToSearch - course info to search for a matching format

formatInfoToMatchWith - format info to match with

Returns:

formatInfo from joint course which matches the format being added by the user at the ui.

retrieveCourseCodes

public List<String> retrieveCourseCodes(String targetTermCode,
                               String catalogCourseCode)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        PermissionDeniedException,
                                        OperationFailedException

The premise of this is rather simple. Return a distinct list of course code. At a minimum there needs to be one character. It then does a char% search. so E% will return all ENGL or any E* codes. This implementation is a little special. It's both cached and recursive. Because this is a structured search and course codes don't update often we can cache this pretty heavily and make some assumptions that allow us to make this very efficient. So a user wants to type and see the type ahead results very quickly. The server wants as few db calls as possible. The "bad" way to do this is to search on Every character entered. If we cache the searches then we'll get much better performance. But we can go one step further because ths is a structured search. The first letter E in ENGL will return EVERY course that starts with an E. So when you search for EN... why would you call the DB if you have already called a search for E. So this uses recursion to build the searches. So, in the average case you will only have to call a db search Once for Every first letter of the course codes.

Returns:

List of distinct course codes or an empty list

Throws:

InvalidParameterException

MissingParameterException

PermissionDeniedException

OperationFailedException