org.kuali.student.enrollment.courseoffering.service
Interface CourseOfferingServiceBusinessLogic

All Known Subinterfaces:

CourseOfferingService

All Known Implementing Classes:

CourseOfferingServiceAOTOverrideImpl, CourseOfferingServiceAuthorizationDecorator, CourseOfferingServiceBusinessLogicImpl, CourseOfferingServiceDecorator, CourseOfferingServiceImpl, CourseOfferingServiceValidationDecorator

public interface CourseOfferingServiceBusinessLogic

Service Logic that is common regardless of how the implementation is realized.

i.e. this functionality can be used in both the mock and real implementations.

Author:

nwright

Method Summary

StatusInfo	generateRegistrationGroupsForCluster(String activityOfferingClusterId, ContextInfo contextInfo) Generates all possible registration groups for the Activity Offering Cluster
StatusInfo	generateRegistrationGroupsForFormatOffering(String formatOfferingId, ContextInfo context) This is a bulk create method for generateRegistrationGroupsForAOC().
SocRolloverResultItemInfo	rolloverCourseOffering(String sourceCoId, String targetTermId, List<String> optionKeys, ContextInfo context)
CourseOfferingInfo	updateCourseOfferingFromCanonical(String courseOfferingId, List<String> optionKeys, ContextInfo context)
List<ValidationResultInfo>	validateCourseOfferingFromCanonical(CourseOfferingInfo courseOfferingInfo, List<String> optionKeys, ContextInfo context)

Method Detail

rolloverCourseOffering

SocRolloverResultItemInfo rolloverCourseOffering(String sourceCoId,
                                                 String targetTermId,
                                                 List<String> optionKeys,
                                                 ContextInfo context)
                                                 throws AlreadyExistsException,
                                                        DataValidationErrorException,
                                                        DoesNotExistException,
                                                        DataValidationErrorException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException,
                                                        ReadOnlyException

Throws:

AlreadyExistsException

DataValidationErrorException

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

ReadOnlyException

updateCourseOfferingFromCanonical

CourseOfferingInfo updateCourseOfferingFromCanonical(String courseOfferingId,
                                                     List<String> optionKeys,
                                                     ContextInfo context)
                                                     throws DataValidationErrorException,
                                                            DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException,
                                                            VersionMismatchException

Throws:

DataValidationErrorException

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

VersionMismatchException

validateCourseOfferingFromCanonical

List<ValidationResultInfo> validateCourseOfferingFromCanonical(CourseOfferingInfo courseOfferingInfo,
                                                               List<String> optionKeys,
                                                               ContextInfo context)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

generateRegistrationGroupsForFormatOffering

StatusInfo generateRegistrationGroupsForFormatOffering(String formatOfferingId,
                                                       ContextInfo context)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException,
                                                              DataValidationErrorException

This is a bulk create method for generateRegistrationGroupsForAOC(). Instead of working on a single Activity Offering Cluster it will work on all of the AOC's of the format offering specified.

Parameters:

formatOfferingId - The identifier of the format offering to generate registration groups for.

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

Returns:

status of the operation (success, failed)

Throws:

DoesNotExistException - The formatOfferingId does not refer to an existing FormatOffering.

InvalidParameterException - The formatOfferingId or context is invalid.

MissingParameterException - the formatOfferingId or context is missing.

OperationFailedException - unable to complete request, can also occur when verification of any AOC in the format offering fails.

PermissionDeniedException - authorization failure

DataValidationErrorException - verification of any of the underlying Activity Offering Cluster's failed.

generateRegistrationGroupsForCluster

StatusInfo generateRegistrationGroupsForCluster(String activityOfferingClusterId,
                                                ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       DataValidationErrorException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Generates all possible registration groups for the Activity Offering Cluster

Parameters:

activityOfferingClusterId - identifier of the Activity Offering Cluster

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

Returns:

status of the operation (success, failed)

Throws:

DoesNotExistException - activityOfferingClusterId does not exist

DataValidationErrorException - verification of the Activity Offering Cluster failed.

InvalidParameterException - invalid contextInfo

MissingParameterException - activityOfferingClusterId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure has occurred