org.kuali.student.enrollment.registration.client.service.impl.util

Class CourseRegistrationAndScheduleOfClassesUtil

java.lang.Object

org.kuali.student.enrollment.registration.client.service.impl.util.CourseRegistrationAndScheduleOfClassesUtil

public class CourseRegistrationAndScheduleOfClassesUtil
extends Object

This class is util class with the common methods to be used in CourseRegistrationClientService and ScheduleOfClassesService

Author:

Kuali Student Team

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
CourseRegistrationAndScheduleOfClassesUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static RegistrationRequestItemInfo	createNewRegistrationRequestItem(String personId, String regGroupId, String masterLprId, String credits, String gradingOptionId, String typeKey, String stateKey, String courseCode, boolean okToWaitlist, boolean okToRepeat) This method creates a registration request for the add operation of a single registration group.
static String	dayDisplayHelper(String day) This method converts Timeslot Day Codes to Timeslot Day Display Codes
static ActivityOfferingScheduleComponentResult	getActivityOfferingScheduleComponent(String isTBA, String roomCode, String buildingCode, String weekdays, String startTimeMs, String endTimeMs)
static Map<String,Integer>	getActivityPriorityMap(ContextInfo contextInfo) This method grabs all kuali.lu.type.grouping.activity types.
static AtpService	getAtpService()
static CourseOfferingInfo	getCourseOfferingIdCreditGrading(String courseOfferingId, String courseCode, String termId, String termCode, ContextInfo contextInfo)
static CourseOfferingService	getCourseOfferingService()
static CourseOfferingSetService	getCourseOfferingSetService()
static CourseRegistrationService	getCourseRegistrationService()
static CourseService	getCourseService()
static IdentityService	getIdentityService()
static LprService	getLprService()
static LRCService	getLrcService()
static RegGroupSearchResult	getRegGroup(String termId, String termCode, String courseCode, String regGroupCode, String regGroupId, ContextInfo contextInfo) Based on the input, get the RegGroupSearchResult.
static RuleManagementService	getRuleManagementService()
static ScheduleOfClassesService	getScheduleOfClassesService()
static SearchService	getSearchService() SERVICES *
static String	getTermId(String termId, String termCode, ContextInfo contextInfo)
static List<TermSearchResult>	getTermsByTermCode(String termCode, ContextInfo contextInfo)
static List<TermSearchResult>	getTermSearchResultsFromAtpInfos(List<AtpInfo> atpInfos)
static TypeService	getTypeService()
static Map<String,List<InstructorSearchResult>>	searchForInstructorsByAoIds(List<String> aoIds, ContextInfo contextInfo) This is an internal method that will return a map of aoId, InstructorSearchResult.
static void	setAtpService(AtpService atpService)
static void	setCourseOfferingService(CourseOfferingService courseOfferingService)
void	setCourseRegistrationService(CourseRegistrationService courseRegistrationService)
static void	setCourseService(CourseService courseService)
static void	setIdentityService(IdentityService identityService)
static void	setLprService(LprService lprService)
void	setLrcService(LRCService lrcService)
void	setRuleManagementService(RuleManagementService ruleManagementService)
void	setScheduleOfClassesService(ScheduleOfClassesService scheduleOfClassesService)
static void	setTypeService(TypeService typeService)
static void	sortActivityOfferingReslutList(List<StudentScheduleActivityOfferingResult> activityOfferingResults, ContextInfo contextInfo) This method takes in a list of activity offering results and sorts them in priority order.
static void	sortActivityOfferings(ActivityOfferingTypesSearchResult aoType) This method takes all of the activity offerings in an activity offering type and sorts them by ao code.
static void	sortActivityOfferingTypeKeyList(List<String> typeKeys, Map<String,Integer> activityPriorityMap) This method takes in a list of activity offering type keys and sorts them in priority order.
static String	translateGradingOptionKeyToName(String gradingOptionKey)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

CourseRegistrationAndScheduleOfClassesUtil

public CourseRegistrationAndScheduleOfClassesUtil()

Method Detail

getTermId

public static String getTermId(String termId,
               String termCode,
               ContextInfo contextInfo)
                        throws InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getTermsByTermCode

public static List<TermSearchResult> getTermsByTermCode(String termCode,
                                        ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        PermissionDeniedException,
                                                        OperationFailedException

Throws:

InvalidParameterException

MissingParameterException

PermissionDeniedException

OperationFailedException

getTermSearchResultsFromAtpInfos

public static List<TermSearchResult> getTermSearchResultsFromAtpInfos(List<AtpInfo> atpInfos)

sortActivityOfferingTypeKeyList

public static void sortActivityOfferingTypeKeyList(List<String> typeKeys,
                                   Map<String,Integer> activityPriorityMap)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   DoesNotExistException,
                                                   PermissionDeniedException,
                                                   OperationFailedException

This method takes in a list of activity offering type keys and sorts them in priority order. The priority order comes from the priority established in the Activity Types.

Parameters:

typeKeys - list of activity offering type keys

Throws:

InvalidParameterException

MissingParameterException

DoesNotExistException

PermissionDeniedException

OperationFailedException

sortActivityOfferings

public static void sortActivityOfferings(ActivityOfferingTypesSearchResult aoType)

This method takes all of the activity offerings in an activity offering type and sorts them by ao code.

Parameters:

aoType - activity offering type

sortActivityOfferingReslutList

public static void sortActivityOfferingReslutList(List<StudentScheduleActivityOfferingResult> activityOfferingResults,
                                  ContextInfo contextInfo)

This method takes in a list of activity offering results and sorts them in priority order. The priority order comes from the priority established in the Activity Types.

Parameters:

activityOfferingResults - list of StudentScheduleActivityOfferingResult

contextInfo - context of the call

getActivityOfferingScheduleComponent

public static ActivityOfferingScheduleComponentResult getActivityOfferingScheduleComponent(String isTBA,
                                                                           String roomCode,
                                                                           String buildingCode,
                                                                           String weekdays,
                                                                           String startTimeMs,
                                                                           String endTimeMs)
                                                                                    throws InvalidParameterException

Throws:

InvalidParameterException

getActivityPriorityMap

public static Map<String,Integer> getActivityPriorityMap(ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         DoesNotExistException,
                                                         PermissionDeniedException,
                                                         OperationFailedException

This method grabs all kuali.lu.type.grouping.activity types. These types have attributes with priority values. Since we are interested in the priority of the lui types, not the lu types we then need to get the type type relation between lu and lui.

Ex: Lu.Lucture priority = 1; Lu.Lecture has a 1:1 relation with Lui.Lecture so we say the Lui.Lecture.priority = Lu.Lecture.priority

These values never change so I'm storing them in a map inside the service for performance reasons.

So, if a course offering has Lec, Lab, Discussion and you want to know which is the Primary type, just get the lowest priority of the ao type.

Parameters:

contextInfo - context of the call

Returns:

mapping of activity type key to the priority

Throws:

InvalidParameterException

MissingParameterException

DoesNotExistException

PermissionDeniedException

OperationFailedException

searchForInstructorsByAoIds

public static Map<String,List<InstructorSearchResult>> searchForInstructorsByAoIds(List<String> aoIds,
                                                                   ContextInfo contextInfo)
                                                                            throws InvalidParameterException,
                                                                                   MissingParameterException,
                                                                                   DoesNotExistException,
                                                                                   PermissionDeniedException,
                                                                                   OperationFailedException

This is an internal method that will return a map of aoId, InstructorSearchResult. We are using a map object so it is easier to build up complex objects in a more performant way

Parameters:

aoIds - list of activity offering ids

contextInfo - context of the call

Returns:

mapping of activity id to list of instructors related to that id

Throws:

InvalidParameterException

MissingParameterException

DoesNotExistException

PermissionDeniedException

OperationFailedException

getRegGroup

public static RegGroupSearchResult getRegGroup(String termId,
                               String termCode,
                               String courseCode,
                               String regGroupCode,
                               String regGroupId,
                               ContextInfo contextInfo)
                                        throws PermissionDeniedException,
                                               MissingParameterException,
                                               InvalidParameterException,
                                               OperationFailedException,
                                               CourseDoesNotExistException

Based on the input, get the RegGroupSearchResult. There are two ways to find it (termCode, courseCode, regGroupName) or just the regGroupId.

Parameters:

termCode - the term code

courseCode - the course code

regGroupCode - the reg group code

regGroupId - the reg group id

contextInfo - context info

Returns:

RegGroupSearchResult

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

CourseDoesNotExistException

getCourseOfferingIdCreditGrading

public static CourseOfferingInfo getCourseOfferingIdCreditGrading(String courseOfferingId,
                                                  String courseCode,
                                                  String termId,
                                                  String termCode,
                                                  ContextInfo contextInfo)
                                                           throws InvalidParameterException,
                                                                  MissingParameterException,
                                                                  PermissionDeniedException,
                                                                  OperationFailedException

Throws:

InvalidParameterException

MissingParameterException

PermissionDeniedException

OperationFailedException

createNewRegistrationRequestItem

public static RegistrationRequestItemInfo createNewRegistrationRequestItem(String personId,
                                                           String regGroupId,
                                                           String masterLprId,
                                                           String credits,
                                                           String gradingOptionId,
                                                           String typeKey,
                                                           String stateKey,
                                                           String courseCode,
                                                           boolean okToWaitlist,
                                                           boolean okToRepeat)

This method creates a registration request for the add operation of a single registration group.

Parameters:

personId - id of person that will be stored in LPR table.

regGroupId - Registration Group id

masterLprId - masterLprId

credits - credits

gradingOptionId - gradingOptionId

okToWaitlist - flag to set if student should automatically be waitlisted when adding to a full reg group with available waitlist

okToRepeat - flag to set if repeatability checks should fail when a student has repeated courses but is still under the max setting

Returns:

registration request

translateGradingOptionKeyToName

public static String translateGradingOptionKeyToName(String gradingOptionKey)

dayDisplayHelper

public static String dayDisplayHelper(String day)

This method converts Timeslot Day Codes to Timeslot Day Display Codes

Parameters:

day - - Timeslot Day Code

Returns:

dayDisplay - Timeslot Day Display Code

getSearchService

public static SearchService getSearchService()

SERVICES *

getLprService

public static LprService getLprService()

setLprService

public static void setLprService(LprService lprService)

getIdentityService

public static IdentityService getIdentityService()

setIdentityService

public static void setIdentityService(IdentityService identityService)

getAtpService

public static AtpService getAtpService()

setAtpService

public static void setAtpService(AtpService atpService)

getCourseService

public static CourseService getCourseService()

setCourseService

public static void setCourseService(CourseService courseService)

getCourseOfferingService

public static CourseOfferingService getCourseOfferingService()

setCourseOfferingService

public static void setCourseOfferingService(CourseOfferingService courseOfferingService)

getTypeService

public static TypeService getTypeService()

setTypeService

public static void setTypeService(TypeService typeService)

getCourseOfferingSetService

public static CourseOfferingSetService getCourseOfferingSetService()

getLrcService

public static LRCService getLrcService()

setLrcService

public void setLrcService(LRCService lrcService)

getScheduleOfClassesService

public static ScheduleOfClassesService getScheduleOfClassesService()

setScheduleOfClassesService

public void setScheduleOfClassesService(ScheduleOfClassesService scheduleOfClassesService)

getCourseRegistrationService

public static CourseRegistrationService getCourseRegistrationService()

setCourseRegistrationService

public void setCourseRegistrationService(CourseRegistrationService courseRegistrationService)

getRuleManagementService

public static RuleManagementService getRuleManagementService()

setRuleManagementService

public void setRuleManagementService(RuleManagementService ruleManagementService)