org.kuali.student.enrollment.class2.examoffering.service.facade

Class ExamOfferingServiceFacadeImpl

java.lang.Object

org.kuali.student.enrollment.class2.examoffering.service.facade.ExamOfferingServiceFacadeImpl

All Implemented Interfaces:

ExamOfferingServiceFacade

public class ExamOfferingServiceFacadeImpl
extends Object
implements ExamOfferingServiceFacade

Implementation of the Application Service Layer to provide the functionally specified functionality using several service calls.

Author:

Kuali Student Team

Field Summary

Fields inherited from interface org.kuali.student.enrollment.class2.examoffering.service.facade.ExamOfferingServiceFacade

RECREATE_OPTION_KEY

Constructor Summary

Constructors

Constructor and Description
ExamOfferingServiceFacadeImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelFinalExamOfferings(String courseOfferingId, ContextInfo context)
void	changeFinalExamOfferingsState(String courseOfferingId, String stateKey, ContextInfo context) This method change all the states of the exam offerings associated with the given courseOfferingId to the given stateKey.
StatusInfo	generateFinalExamOffering(CourseOfferingInfo courseOfferingInfo, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context) This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers.
StatusInfo	generateFinalExamOffering(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context) This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers.
StatusInfo	generateFinalExamOfferingForAO(ActivityOfferingInfo activityOfferingInfo, String termId, String examPeriodID, List<String> optionKeys, ContextInfo context) This method is used to create exam offerings for new activity offerings that are added to the course offering after the rollover process was completed.
StatusInfo	generateFinalExamOfferingForAO(CourseOfferingInfo courseOfferingInfo, ActivityOfferingInfo activityOfferingInfo, String termId, String examPeriodID, String finalExamLevelTypeKey, List<String> optionKeys, ContextInfo context) This method is used to create exam offerings for new activity offerings that are added to the course offering after the rollover process was completed.
StatusInfo	generateFinalExamOfferingOptimized(CourseOfferingInfo courseOfferingInfo, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context, Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs) This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers.
void	generateFinalExamOfferingsPerAO(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context) Generates an Exam Offering for each Activity Offering.
void	generateFinalExamOfferingsPerAOOptimized(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context, Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs) An "optimized" version of generateFinalExamOfferingsPerAO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.
void	generateFinalExamOfferingsPerCO(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context)
void	generateFinalExamOfferingsPerCOOptimized(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context, Map<String,List<ActivityOfferingInfo>> foIdToListOfAO) An "optimized" version of generateFinalExamOfferingsPerCO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.
void	generateFinalExamOfferingsPerFO(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context) Generates a single Exam Offering per Format Offering.
void	generateFinalExamOfferingsPerFOOptimized(String courseOfferingId, String termId, String examPeriodId, List<String> optionKeys, ContextInfo context, Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs) An "optimized" version of generateFinalExamOfferingsPerFO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.
AtpService	getAtpService()
CourseOfferingService	getCourseOfferingService()
List<ExamOfferingRelationInfo>	getExamOfferingRelationsByCourseOffering(String courseOfferingId, ContextInfo contextInfo) Retrieves a list of ExamOfferingRelations to the given FormatOffering.
ExamOfferingService	getExamOfferingService()
String	getExamPeriodId(String termID, ContextInfo context) This method retrieves the exam period id for the term that the given course offering is attached to.
ExamService	getExamService()
CourseOfferingSetService	getSocService()
TypeService	getTypeService()
boolean	isSetLocation() This method retrieves the boolea value to indicate if the execution process should or not set the location on the RDL.
void	removeFinalExamOfferingsFromCO(String courseOfferingId, ContextInfo context) This method removes all Exam Offering from the Course Offering for the given Coure Offering Id.
void	setAtpService(AtpService atpService)
void	setCourseOfferingService(CourseOfferingService courseOfferingService)
void	setExamOfferingService(ExamOfferingService examOfferingService)
void	setExamService(ExamService examService)
void	setSetLocation(boolean setLocation)
void	setSocService(CourseOfferingSetService socService)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExamOfferingServiceFacadeImpl

public ExamOfferingServiceFacadeImpl()

Method Detail

generateFinalExamOffering

public StatusInfo generateFinalExamOffering(String courseOfferingId,
                                   String termId,
                                   String examPeriodId,
                                   List<String> optionKeys,
                                   ContextInfo context)
                                     throws DoesNotExistException,
                                            DataValidationErrorException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException,
                                            ReadOnlyException

Description copied from interface: ExamOfferingServiceFacade

This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers. If the Final Exam Status is not STANDARD, then all Exam Offerings will be cancelled If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOffering in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

DataValidationErrorException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

generateFinalExamOffering

public StatusInfo generateFinalExamOffering(CourseOfferingInfo courseOfferingInfo,
                                   String termId,
                                   String examPeriodId,
                                   List<String> optionKeys,
                                   ContextInfo context)
                                     throws DoesNotExistException,
                                            DataValidationErrorException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException,
                                            ReadOnlyException

Description copied from interface: ExamOfferingServiceFacade

This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers. If the Final Exam Status is not STANDARD, then all Exam Offerings will be cancelled If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOffering in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

DataValidationErrorException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

generateFinalExamOfferingOptimized

public StatusInfo generateFinalExamOfferingOptimized(CourseOfferingInfo courseOfferingInfo,
                                            String termId,
                                            String examPeriodId,
                                            List<String> optionKeys,
                                            ContextInfo context,
                                            Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs)
                                              throws DoesNotExistException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     ReadOnlyException

Description copied from interface: ExamOfferingServiceFacade

This method generates new Exam Offerings for the Course Offering for the given Course Offering Id based on the exam drivers. If the Final Exam Status is not STANDARD, then all Exam Offerings will be cancelled If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOfferingOptimized in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

DataValidationErrorException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

generateFinalExamOfferingForAO

public StatusInfo generateFinalExamOfferingForAO(ActivityOfferingInfo activityOfferingInfo,
                                        String termId,
                                        String examPeriodID,
                                        List<String> optionKeys,
                                        ContextInfo context)
                                          throws DoesNotExistException,
                                                 DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException,
                                                 ReadOnlyException,
                                                 VersionMismatchException

Description copied from interface: ExamOfferingServiceFacade

This method is used to create exam offerings for new activity offerings that are added to the course offering after the rollover process was completed. If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOfferingForAO in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

DataValidationErrorException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

VersionMismatchException

generateFinalExamOfferingForAO

public StatusInfo generateFinalExamOfferingForAO(CourseOfferingInfo courseOfferingInfo,
                                        ActivityOfferingInfo activityOfferingInfo,
                                        String termId,
                                        String examPeriodID,
                                        String finalExamLevelTypeKey,
                                        List<String> optionKeys,
                                        ContextInfo context)
                                          throws DoesNotExistException,
                                                 DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException,
                                                 ReadOnlyException,
                                                 VersionMismatchException

Description copied from interface: ExamOfferingServiceFacade

This method is used to create exam offerings for new activity offerings that are added to the course offering after the rollover process was completed. If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOfferingForAO in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

DataValidationErrorException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

VersionMismatchException

getExamPeriodId

public String getExamPeriodId(String termID,
                     ContextInfo context)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: ExamOfferingServiceFacade

This method retrieves the exam period id for the term that the given course offering is attached to.

Specified by:

getExamPeriodId in interface ExamOfferingServiceFacade

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

generateFinalExamOfferingsPerCO

public void generateFinalExamOfferingsPerCO(String courseOfferingId,
                                   String termId,
                                   String examPeriodId,
                                   List<String> optionKeys,
                                   ContextInfo context)
                                     throws PermissionDeniedException,
                                            MissingParameterException,
                                            InvalidParameterException,
                                            OperationFailedException,
                                            DoesNotExistException,
                                            ReadOnlyException,
                                            DataValidationErrorException

Specified by:

generateFinalExamOfferingsPerCO in interface ExamOfferingServiceFacade

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

generateFinalExamOfferingsPerCOOptimized

public void generateFinalExamOfferingsPerCOOptimized(String courseOfferingId,
                                            String termId,
                                            String examPeriodId,
                                            List<String> optionKeys,
                                            ContextInfo context,
                                            Map<String,List<ActivityOfferingInfo>> foIdToListOfAO)
                                              throws PermissionDeniedException,
                                                     MissingParameterException,
                                                     InvalidParameterException,
                                                     OperationFailedException,
                                                     DoesNotExistException,
                                                     ReadOnlyException,
                                                     DataValidationErrorException

Description copied from interface: ExamOfferingServiceFacade

An "optimized" version of generateFinalExamOfferingsPerCO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.

Specified by:

generateFinalExamOfferingsPerCOOptimized in interface ExamOfferingServiceFacade

foIdToListOfAO - For the courseOfferingId, this is a map from FO Ids (of the CO) to the AO Infos belonging to the FO. Saves a service call by passing this info in.

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

getExamOfferingRelationsByCourseOffering

public List<ExamOfferingRelationInfo> getExamOfferingRelationsByCourseOffering(String courseOfferingId,
                                                                      ContextInfo contextInfo)
                                                                        throws InvalidParameterException,
                                                                               MissingParameterException,
                                                                               OperationFailedException,
                                                                               DoesNotExistException,
                                                                               PermissionDeniedException

Description copied from interface: ExamOfferingServiceFacade

Retrieves a list of ExamOfferingRelations to the given FormatOffering.

Specified by:

getExamOfferingRelationsByCourseOffering in interface ExamOfferingServiceFacade

Parameters:

courseOfferingId - the identifier for the CourseOffering

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the ExamOfferingRelations to the given FormatOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is invalid

MissingParameterException - formatOfferingId or contextInfo is missing or null

OperationFailedException - unable to complete request

DoesNotExistException

PermissionDeniedException - an authorization failure occurred

generateFinalExamOfferingsPerFO

public void generateFinalExamOfferingsPerFO(String courseOfferingId,
                                   String termId,
                                   String examPeriodId,
                                   List<String> optionKeys,
                                   ContextInfo context)
                                     throws PermissionDeniedException,
                                            MissingParameterException,
                                            InvalidParameterException,
                                            OperationFailedException,
                                            DoesNotExistException,
                                            ReadOnlyException,
                                            DataValidationErrorException

Description copied from interface: ExamOfferingServiceFacade

Generates a single Exam Offering per Format Offering. If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOfferingsPerFO in interface ExamOfferingServiceFacade

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

generateFinalExamOfferingsPerFOOptimized

public void generateFinalExamOfferingsPerFOOptimized(String courseOfferingId,
                                            String termId,
                                            String examPeriodId,
                                            List<String> optionKeys,
                                            ContextInfo context,
                                            Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs)
                                              throws PermissionDeniedException,
                                                     MissingParameterException,
                                                     InvalidParameterException,
                                                     OperationFailedException,
                                                     DoesNotExistException,
                                                     ReadOnlyException,
                                                     DataValidationErrorException

Description copied from interface: ExamOfferingServiceFacade

An "optimized" version of generateFinalExamOfferingsPerFO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.

Specified by:

generateFinalExamOfferingsPerFOOptimized in interface ExamOfferingServiceFacade

foIdToListOfAOs - For the courseOfferingId, this is a map from FO Ids (of the CO) to the AO Infos belonging to the FO. Saves a service call by passing this info in.

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

generateFinalExamOfferingsPerAO

public void generateFinalExamOfferingsPerAO(String courseOfferingId,
                                   String termId,
                                   String examPeriodId,
                                   List<String> optionKeys,
                                   ContextInfo context)
                                     throws PermissionDeniedException,
                                            MissingParameterException,
                                            InvalidParameterException,
                                            OperationFailedException,
                                            DoesNotExistException,
                                            ReadOnlyException,
                                            DataValidationErrorException

Description copied from interface: ExamOfferingServiceFacade

Generates an Exam Offering for each Activity Offering. If the Final Exam Driver changes, the existing offerings will be cancelled and new offerings created based on new driver, or cancelled exam offerings for the current driver will be reinstated if they do exist.

Specified by:

generateFinalExamOfferingsPerAO in interface ExamOfferingServiceFacade

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

generateFinalExamOfferingsPerAOOptimized

public void generateFinalExamOfferingsPerAOOptimized(String courseOfferingId,
                                            String termId,
                                            String examPeriodId,
                                            List<String> optionKeys,
                                            ContextInfo context,
                                            Map<String,List<ActivityOfferingInfo>> foIdToListOfAOs)
                                              throws PermissionDeniedException,
                                                     MissingParameterException,
                                                     InvalidParameterException,
                                                     OperationFailedException,
                                                     DoesNotExistException,
                                                     ReadOnlyException,
                                                     DataValidationErrorException

Description copied from interface: ExamOfferingServiceFacade

An "optimized" version of generateFinalExamOfferingsPerAO where a map of foId to a list of AOids is passed in (for this CO) to avoid additional calls to the DB.

Specified by:

generateFinalExamOfferingsPerAOOptimized in interface ExamOfferingServiceFacade

foIdToListOfAOs - For the courseOfferingId, this is a map from FO Ids (of the CO) to the AO Infos belonging to the FO. Saves a service call by passing this info in.

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

removeFinalExamOfferingsFromCO

public void removeFinalExamOfferingsFromCO(String courseOfferingId,
                                  ContextInfo context)
                                    throws PermissionDeniedException,
                                           MissingParameterException,
                                           InvalidParameterException,
                                           OperationFailedException,
                                           DoesNotExistException

Description copied from interface: ExamOfferingServiceFacade

This method removes all Exam Offering from the Course Offering for the given Coure Offering Id. This include all the Exam Offering for the Format Offerings and Activity Offerings linked to the Course Offering.

Specified by:

removeFinalExamOfferingsFromCO in interface ExamOfferingServiceFacade

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

cancelFinalExamOfferings

public void cancelFinalExamOfferings(String courseOfferingId,
                            ContextInfo context)
                              throws PermissionDeniedException,
                                     MissingParameterException,
                                     InvalidParameterException,
                                     OperationFailedException,
                                     DoesNotExistException

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

changeFinalExamOfferingsState

public void changeFinalExamOfferingsState(String courseOfferingId,
                                 String stateKey,
                                 ContextInfo context)
                                   throws PermissionDeniedException,
                                          MissingParameterException,
                                          InvalidParameterException,
                                          OperationFailedException,
                                          DoesNotExistException

Description copied from interface: ExamOfferingServiceFacade

This method change all the states of the exam offerings associated with the given courseOfferingId to the given stateKey.

Specified by:

changeFinalExamOfferingsState in interface ExamOfferingServiceFacade

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

getAtpService

public AtpService getAtpService()

setAtpService

public void setAtpService(AtpService atpService)

getExamService

public ExamService getExamService()

setExamService

public void setExamService(ExamService examService)

getCourseOfferingService

public CourseOfferingService getCourseOfferingService()

setCourseOfferingService

public void setCourseOfferingService(CourseOfferingService courseOfferingService)

getExamOfferingService

public ExamOfferingService getExamOfferingService()

setExamOfferingService

public void setExamOfferingService(ExamOfferingService examOfferingService)

getSocService

public CourseOfferingSetService getSocService()

setSocService

public void setSocService(CourseOfferingSetService socService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

isSetLocation

public boolean isSetLocation()

Description copied from interface: ExamOfferingServiceFacade

This method retrieves the boolea value to indicate if the execution process should or not set the location on the RDL.

Specified by:

isSetLocation in interface ExamOfferingServiceFacade

setSetLocation

public void setSetLocation(boolean setLocation)