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

Class AbstractCourseRegistrationService

java.lang.Object

org.kuali.student.enrollment.class2.courseregistration.service.impl.AbstractCourseRegistrationService

All Implemented Interfaces:

CourseRegistrationService

Direct Known Subclasses:

CourseRegistrationServiceImpl, CourseRegistrationServiceMockImpl

public abstract class AbstractCourseRegistrationService
extends Object
implements CourseRegistrationService

Constructor Summary

Constructors

Constructor and Description
AbstractCourseRegistrationService()

Method Summary

Methods

Modifier and Type	Method and Description
CreditLoadInfo	calculateCreditLoadForStudentRegistrationRequest(String registrationRequestId, String studentId, ContextInfo contextInfo) Calculate the credit load for a given student in a given RegistrationRequest.
List<ValidationResultInfo>	checkStudentEligibility(String studentId, ContextInfo contextInfo) Checks if a student is eligible to enter the registration process.
List<ValidationResultInfo>	checkStudentEligibilityForTerm(String studentId, String termId, ContextInfo contextInfo) Checks the eligibility of a student to register in a particular term.
List<ValidationResultInfo>	checkStudentEligibiltyForCourseOffering(String studentId, String courseOfferingId, ContextInfo contextInfo) Checks if the student is eligible to register for a particular course offering.
List<ValidationResultInfo>	checkStudentEligibiltyForRegistrationGroup(String studentId, String registrationGroupId, ContextInfo contextInfo) Checks if the student is eligible to register for a particular registration group.
RegistrationRequestInfo	createRegistrationRequest(String registrationRequestTypeKey, RegistrationRequestInfo registrationRequestInfo, ContextInfo contextInfo) Creates a new RegistrationRequest.
RegistrationRequestInfo	createRegistrationRequestFromExisting(String registrationRequestId, ContextInfo contextInfo) A utiligy to create a new RegistrationRequest from an existing RegistrationRequest.
StatusInfo	deleteRegistrationRequest(String registrationRequestId, ContextInfo contextInfo) Deletes an existing RegistrationRequest.
ActivityRegistrationInfo	getActivityRegistration(String activityRegistrationId, ContextInfo contextInfo) Retrieves a single ActivityRegistration by an ActivityRegistration Id.
List<String>	getActivityRegistrationIdsByType(String activityRegistrationTypeKey, ContextInfo contextInfo) Retrieve a list of ActivityRegistrationIds by ActivityRegistration Type.
List<ActivityRegistrationInfo>	getActivityRegistrationsByActivityOffering(String courseOfferingId, ContextInfo contextInfo) Gets a list of ActivityRegistrations for a given ActivityOffering.
List<ActivityRegistrationInfo>	getActivityRegistrationsByIds(List<String> activityRegistrationIds, ContextInfo contextInfo) Retrieve a list of ActivityRegistrations from a list of ActivityRegistration Ids.
List<ActivityRegistrationInfo>	getActivityRegistrationsByStudent(String studentId, ContextInfo contextInfo) Gets a list of ActivityRegistrations for a given Student.
List<ActivityRegistrationInfo>	getActivityRegistrationsByStudentAndActivityOffering(String studentId, String courseOfferingId, ContextInfo contextInfo) Gets a list of ActivityRegistrations for a given Student and ActivityOffering.
List<ActivityRegistrationInfo>	getActivityRegistrationsByStudentAndTerm(String studentId, String termId, ContextInfo contextInfo) Gets a list of ActivityRegistrations for a given Student and Term.
List<ActivityRegistrationInfo>	getActivityRegistrationsForCourseRegistration(String courseRegistrationId, ContextInfo contextInfo) Gets a list of ActivityRegistrations for a CourseRegistration.
CourseRegistrationInfo	getCourseRegistration(String courseRegistrationId, ContextInfo contextInfo) Retrieves a single CourseRegistration by an CourseRegistration Id.
List<String>	getCourseRegistrationIdsByType(String courseRegistrationTypeKey, ContextInfo contextInfo) Retrieve a list of CourseRegistrationIds by CourseRegistration Type.
List<CourseRegistrationInfo>	getCourseRegistrationsByCourseOffering(String courseOfferingId, ContextInfo contextInfo) Gets a list of CourseRegistrations for a given CourseOffering.
List<CourseRegistrationInfo>	getCourseRegistrationsByIds(List<String> courseRegistrationIds, ContextInfo contextInfo) Retrieve a list of CourseRegistrations from a list of CourseRegistration Ids.
List<CourseRegistrationInfo>	getCourseRegistrationsByStudent(String studentId, ContextInfo contextInfo) Gets a list of CourseRegistrations for a given Student.
List<CourseRegistrationInfo>	getCourseRegistrationsByStudentAndCourseOffering(String studentId, String courseOfferingId, ContextInfo contextInfo) Gets a list of CourseRegistrations for a given Student and CourseOffering.
List<CourseRegistrationInfo>	getCourseRegistrationsByStudentAndTerm(String studentId, String termId, ContextInfo contextInfo) Gets a list of CourseRegistrations for a given Student and Term.
List<RegistrationGroupInfo>	getEligibleRegistrationGroupsForStudentInCourseOffering(String studentId, String courseOfferingId, ContextInfo contextInfo) Gets the Registration Groups for a CourseOffering for which the given student is eligible to register.
RegistrationRequestInfo	getRegistrationRequest(String registrationRequestId, ContextInfo contextInfo) Retrieves a single RegistrationRequest by an RegistrationRequest Id.
List<String>	getRegistrationRequestIdsByType(String registrationRequestTypeKey, ContextInfo contextInfo) Retrieve a list of RegistrationRequestIds by RegistrationRequest Type.
List<RegistrationRequestItemInfo>	getRegistrationRequestItemsByCourseOfferingAndStudent(String courseOfferingId, String studentId, ContextInfo contextInfo) Gets list of RegistrationRequestItems resulting in or impacting a Student's registration in a CourseOffering.
List<RegistrationRequestItemInfo>	getRegistrationRequestItemsForCourseRegistration(String courseRegistrationId, ContextInfo contextInfo) Gets the RegistrationRequestItems that resulted in or impacted the given CourseRegistration.
List<RegistrationRequestInfo>	getRegistrationRequestsByIds(List<String> registrationRequestIds, ContextInfo contextInfo) Retrieve a list of RegistrationRequests from a list of RegistrationRequest Ids.
List<RegistrationRequestInfo>	getRegistrationRequestsByRequestor(String personId, ContextInfo contextInfo) Gets a list of RegistrationRequests by requesting person Id.
List<RegistrationRequestInfo>	getUnsubmittedRegistrationRequestsByRequestorAndTerm(String requestorId, String termId, ContextInfo contextInfo) Gets a list of unsubmitted RegistrationRequests by requesting person Id and Term.
List<String>	searchForActivityRegistrationIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for ActivityRegistrations that meet the given search criteria.
List<ActivityRegistrationInfo>	searchForActivityRegistrations(QueryByCriteria criteria, ContextInfo contextInfo) Searches for ActivityRegistrations that meet the given search criteria.
List<String>	searchForCourseRegistrationIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for CourseRegistrations that meet the given search criteria.
List<CourseRegistrationInfo>	searchForCourseRegistrations(QueryByCriteria criteria, ContextInfo contextInfo) Searches for CourseRegistrations that meet the given search criteria.
List<String>	searchForRegistrationRequestIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for RegistrationRequests that meet the given search criteria.
List<RegistrationRequestInfo>	searchForRegistrationRequests(QueryByCriteria criteria, ContextInfo contextInfo) Searches for RegistrationRequests that meet the given search criteria.
RegistrationResponseInfo	submitRegistrationRequest(String registrationRequestId, ContextInfo contextInfo) Submits a RegsitrationRequest.
RegistrationRequestInfo	updateRegistrationRequest(String registrationRequestId, RegistrationRequestInfo registrationRequestInfo, ContextInfo contextInfo) Updates an existing RegistrationRequest.
List<ValidationResultInfo>	validateRegistrationRequest(String validationTypeKey, String registrationRequestTypeKey, RegistrationRequestInfo registrationRequestInfo, ContextInfo contextInfo) Validates an RegistrationRequest.
List<ValidationResultInfo>	verifyRegistrationRequestForSubmission(String registrationRequestId, ContextInfo contextInfo) Verifies a persisted RegistrationRequest for submission.

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.courseregistration.service.CourseRegistrationService

changeRegistrationRequestState

Constructor Detail

AbstractCourseRegistrationService

public AbstractCourseRegistrationService()

Method Detail

getCourseRegistration

public CourseRegistrationInfo getCourseRegistration(String courseRegistrationId,
                                           ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieves a single CourseRegistration by an CourseRegistration Id.

Specified by:

getCourseRegistration in interface CourseRegistrationService

Parameters:

courseRegistrationId - the identifier for the CourseRegistration to be retrieved

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

Returns:

the CourseRegistration requested

Throws:

DoesNotExistException - courseRegistrationId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseRegistrationId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationsByIds

public List<CourseRegistrationInfo> getCourseRegistrationsByIds(List<String> courseRegistrationIds,
                                                       ContextInfo contextInfo)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of CourseRegistrations from a list of CourseRegistration Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.

Specified by:

getCourseRegistrationsByIds in interface CourseRegistrationService

Parameters:

courseRegistrationIds - a list of CourseRegistration identifiers

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

Returns:

a list of CourseRegistrations

Throws:

DoesNotExistException - a courseRegistrationId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseRegistrationIds, an Id in courseRegistrationIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationIdsByType

public List<String> getCourseRegistrationIdsByType(String courseRegistrationTypeKey,
                                          ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of CourseRegistrationIds by CourseRegistration Type.

Specified by:

getCourseRegistrationIdsByType in interface CourseRegistrationService

Parameters:

courseRegistrationTypeKey - an identifier for an CourseRegistration Type

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

Returns:

a list of CourseRegistrations identifiers matching courseRegistrationTypeKey or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseRegistrationTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationsByStudent

public List<CourseRegistrationInfo> getCourseRegistrationsByStudent(String studentId,
                                                           ContextInfo contextInfo)
                                                             throws InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of CourseRegistrations for a given Student.

Specified by:

getCourseRegistrationsByStudent in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

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

Returns:

list of CourseRegistrations associated with the given Student or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationsByCourseOffering

public List<CourseRegistrationInfo> getCourseRegistrationsByCourseOffering(String courseOfferingId,
                                                                  ContextInfo contextInfo)
                                                                    throws InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of CourseRegistrations for a given CourseOffering.

Specified by:

getCourseRegistrationsByCourseOffering in interface CourseRegistrationService

Parameters:

courseOfferingId - an identifier for a CourseOffering

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

Returns:

list of CourseRegistrations associated with the given CourseOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseOfferingId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationsByStudentAndCourseOffering

public List<CourseRegistrationInfo> getCourseRegistrationsByStudentAndCourseOffering(String studentId,
                                                                            String courseOfferingId,
                                                                            ContextInfo contextInfo)
                                                                              throws InvalidParameterException,
                                                                                     MissingParameterException,
                                                                                     OperationFailedException,
                                                                                     PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of CourseRegistrations for a given Student and CourseOffering.

Specified by:

getCourseRegistrationsByStudentAndCourseOffering in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

courseOfferingId - an identifier for a CourseOffering

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

Returns:

list of CourseRegistrations associated with the given Student and CourseOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, courseOfferingId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCourseRegistrationsByStudentAndTerm

public List<CourseRegistrationInfo> getCourseRegistrationsByStudentAndTerm(String studentId,
                                                                  String termId,
                                                                  ContextInfo contextInfo)
                                                                    throws InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of CourseRegistrations for a given Student and Term.

Specified by:

getCourseRegistrationsByStudentAndTerm in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

termId - an identifier for a Term

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

Returns:

list of CourseRegistrations associated with the given Student and CourseOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, termId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForCourseRegistrationIds

public List<String> searchForCourseRegistrationIds(QueryByCriteria criteria,
                                          ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for CourseRegistrations that meet the given search criteria.

Specified by:

searchForCourseRegistrationIds in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of CourseRegistration identifiers matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForCourseRegistrations

public List<CourseRegistrationInfo> searchForCourseRegistrations(QueryByCriteria criteria,
                                                        ContextInfo contextInfo)
                                                          throws InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for CourseRegistrations that meet the given search criteria.

Specified by:

searchForCourseRegistrations in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of CourseRegistrations matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistration

public ActivityRegistrationInfo getActivityRegistration(String activityRegistrationId,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieves a single ActivityRegistration by an ActivityRegistration Id.

Specified by:

getActivityRegistration in interface CourseRegistrationService

Parameters:

activityRegistrationId - the identifier for the ActivityRegistration to be retrieved

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

Returns:

the ActivityRegistration requested

Throws:

DoesNotExistException - activityRegistrationId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - activityRegistrationId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsByIds

public List<ActivityRegistrationInfo> getActivityRegistrationsByIds(List<String> activityRegistrationIds,
                                                           ContextInfo contextInfo)
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of ActivityRegistrations from a list of ActivityRegistration Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.

Specified by:

getActivityRegistrationsByIds in interface CourseRegistrationService

Parameters:

activityRegistrationIds - a list of ActivityRegistration identifiers

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

Returns:

a list of ActivityRegistrations

Throws:

DoesNotExistException - a activityRegistrationId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - activityRegistrationIds, an Id in activityRegistrationIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationIdsByType

public List<String> getActivityRegistrationIdsByType(String activityRegistrationTypeKey,
                                            ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of ActivityRegistrationIds by ActivityRegistration Type.

Specified by:

getActivityRegistrationIdsByType in interface CourseRegistrationService

Parameters:

activityRegistrationTypeKey - an identifier for an ActivityRegistration Type

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

Returns:

a list of ActivityRegistrations identifiers matching activityRegistrationTypeKey or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - activityRegistrationTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsForCourseRegistration

public List<ActivityRegistrationInfo> getActivityRegistrationsForCourseRegistration(String courseRegistrationId,
                                                                           ContextInfo contextInfo)
                                                                             throws InvalidParameterException,
                                                                                    MissingParameterException,
                                                                                    OperationFailedException,
                                                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of ActivityRegistrations for a CourseRegistration.

Specified by:

getActivityRegistrationsForCourseRegistration in interface CourseRegistrationService

Parameters:

courseRegistrationId - an identifier for a CourseRegistration

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

Returns:

list of ActivityRegistrations associated with the given CourseRegistration or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseRegistrationId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsByStudent

public List<ActivityRegistrationInfo> getActivityRegistrationsByStudent(String studentId,
                                                               ContextInfo contextInfo)
                                                                 throws InvalidParameterException,
                                                                        MissingParameterException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of ActivityRegistrations for a given Student.

Specified by:

getActivityRegistrationsByStudent in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

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

Returns:

list of ActivityRegistrations associated with the given Student or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsByActivityOffering

public List<ActivityRegistrationInfo> getActivityRegistrationsByActivityOffering(String courseOfferingId,
                                                                        ContextInfo contextInfo)
                                                                          throws InvalidParameterException,
                                                                                 MissingParameterException,
                                                                                 OperationFailedException,
                                                                                 PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of ActivityRegistrations for a given ActivityOffering.

Specified by:

getActivityRegistrationsByActivityOffering in interface CourseRegistrationService

Parameters:

courseOfferingId - an identifier for a ActivityOffering

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

Returns:

list of ActivityRegistrations associated with the given ActivityOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseOfferingId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsByStudentAndActivityOffering

public List<ActivityRegistrationInfo> getActivityRegistrationsByStudentAndActivityOffering(String studentId,
                                                                                  String courseOfferingId,
                                                                                  ContextInfo contextInfo)
                                                                                    throws InvalidParameterException,
                                                                                           MissingParameterException,
                                                                                           OperationFailedException,
                                                                                           PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of ActivityRegistrations for a given Student and ActivityOffering.

Specified by:

getActivityRegistrationsByStudentAndActivityOffering in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

courseOfferingId - an identifier for a ActivityOffering

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

Returns:

list of ActivityRegistrations associated with the given Student and ActivityOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, courseOfferingId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getActivityRegistrationsByStudentAndTerm

public List<ActivityRegistrationInfo> getActivityRegistrationsByStudentAndTerm(String studentId,
                                                                      String termId,
                                                                      ContextInfo contextInfo)
                                                                        throws InvalidParameterException,
                                                                               MissingParameterException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of ActivityRegistrations for a given Student and Term.

Specified by:

getActivityRegistrationsByStudentAndTerm in interface CourseRegistrationService

Parameters:

studentId - an identifier for a Student

termId - an identifier for a Term

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

Returns:

list of ActivityRegistrations associated with the given Student and ActivityOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, termId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForActivityRegistrationIds

public List<String> searchForActivityRegistrationIds(QueryByCriteria criteria,
                                            ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for ActivityRegistrations that meet the given search criteria.

Specified by:

searchForActivityRegistrationIds in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of ActivityRegistration identifiers matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForActivityRegistrations

public List<ActivityRegistrationInfo> searchForActivityRegistrations(QueryByCriteria criteria,
                                                            ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for ActivityRegistrations that meet the given search criteria.

Specified by:

searchForActivityRegistrations in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of ActivityRegistrations matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRegistrationRequest

public RegistrationRequestInfo getRegistrationRequest(String registrationRequestId,
                                             ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieves a single RegistrationRequest by an RegistrationRequest Id.

Specified by:

getRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestId - the identifier for the RegistrationRequest to be retrieved

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

Returns:

the RegistrationRequest requested

Throws:

DoesNotExistException - registrationRequestId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRegistrationRequestsByIds

public List<RegistrationRequestInfo> getRegistrationRequestsByIds(List<String> registrationRequestIds,
                                                         ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of RegistrationRequests from a list of RegistrationRequest Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.

Specified by:

getRegistrationRequestsByIds in interface CourseRegistrationService

Parameters:

registrationRequestIds - a list of RegistrationRequest identifiers

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

Returns:

a list of RegistrationRequests

Throws:

DoesNotExistException - a registrationRequestId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestIds, an Id in registrationRequestIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRegistrationRequestIdsByType

public List<String> getRegistrationRequestIdsByType(String registrationRequestTypeKey,
                                           ContextInfo contextInfo)
                                             throws InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Retrieve a list of RegistrationRequestIds by RegistrationRequest Type.

Specified by:

getRegistrationRequestIdsByType in interface CourseRegistrationService

Parameters:

registrationRequestTypeKey - an identifier for an RegistrationRequest Type

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

Returns:

a list of RegistrationRequests identifiers matching registrationRequestTypeKey or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRegistrationRequestsByRequestor

public List<RegistrationRequestInfo> getRegistrationRequestsByRequestor(String personId,
                                                               ContextInfo contextInfo)
                                                                 throws InvalidParameterException,
                                                                        MissingParameterException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of RegistrationRequests by requesting person Id.

Specified by:

getRegistrationRequestsByRequestor in interface CourseRegistrationService

Parameters:

personId - an identifier for a Person

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

Returns:

list of RegistrationRequests associated with the given Lui or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - personId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getUnsubmittedRegistrationRequestsByRequestorAndTerm

public List<RegistrationRequestInfo> getUnsubmittedRegistrationRequestsByRequestorAndTerm(String requestorId,
                                                                                 String termId,
                                                                                 ContextInfo contextInfo)
                                                                                   throws InvalidParameterException,
                                                                                          MissingParameterException,
                                                                                          OperationFailedException,
                                                                                          PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets a list of unsubmitted RegistrationRequests by requesting person Id and Term.

Specified by:

getUnsubmittedRegistrationRequestsByRequestorAndTerm in interface CourseRegistrationService

termId - an identifier for a Term

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

Returns:

list of RegistrationRequests associated with the given Lui or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - personId, termId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForRegistrationRequestIds

public List<String> searchForRegistrationRequestIds(QueryByCriteria criteria,
                                           ContextInfo contextInfo)
                                             throws InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for RegistrationRequests that meet the given search criteria.

Specified by:

searchForRegistrationRequestIds in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of RegistrationRequest identifiers matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForRegistrationRequests

public List<RegistrationRequestInfo> searchForRegistrationRequests(QueryByCriteria criteria,
                                                          ContextInfo contextInfo)
                                                            throws InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Description copied from interface: CourseRegistrationService

Searches for RegistrationRequests that meet the given search criteria.

Specified by:

searchForRegistrationRequests in interface CourseRegistrationService

Parameters:

criteria - the search criteria

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

Returns:

a list of RegistrationRequests matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateRegistrationRequest

public List<ValidationResultInfo> validateRegistrationRequest(String validationTypeKey,
                                                     String registrationRequestTypeKey,
                                                     RegistrationRequestInfo registrationRequestInfo,
                                                     ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Description copied from interface: CourseRegistrationService

Validates an RegistrationRequest. Depending on the value of validationType, this validation could be limited to tests on just the current RegistrationRequest and its directly contained sub-objects or expanded to perform all tests related to this RegistrationRequest. If an identifier is present for the RegistrationRequest (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the RegistrationRequest can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the RegistrationRequest with the given data can be created.

Specified by:

validateRegistrationRequest in interface CourseRegistrationService

Parameters:

validationTypeKey - the identifier for the validation Type

registrationRequestTypeKey - the identifier for the RegistrationRequest Type to be validated

registrationRequestInfo - the RegistrationRequest to be validated

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

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey or registrationRequestTypeKey is not found

InvalidParameterException - registrationRequestInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, registrationRequestTypeKey, registrationRequestInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createRegistrationRequest

public RegistrationRequestInfo createRegistrationRequest(String registrationRequestTypeKey,
                                                RegistrationRequestInfo registrationRequestInfo,
                                                ContextInfo contextInfo)
                                                  throws DataValidationErrorException,
                                                         DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException,
                                                         ReadOnlyException

Description copied from interface: CourseRegistrationService

Creates a new RegistrationRequest. The RegistrationRequest Id, Type, and Meta information may not be set in the supplied data object.

Specified by:

createRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestTypeKey - the identifier for the Type of RegistrationRequest to be created

registrationRequestInfo - the data with which to create the RegistrationRequest

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

Returns:

the new RegistrationRequest

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - registrationRequestTypeKey does not exist or is not supported

InvalidParameterException - registrationRequestInfo or contextInfo is not valid

MissingParameterException - registrationRequestTypeKey, registrationRequestInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

createRegistrationRequestFromExisting

public RegistrationRequestInfo createRegistrationRequestFromExisting(String registrationRequestId,
                                                            ContextInfo contextInfo)
                                                              throws DoesNotExistException,
                                                                     InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Description copied from interface: CourseRegistrationService

A utiligy to create a new RegistrationRequest from an existing RegistrationRequest. Once a RegistrationRequest is submitted, it cannot be reused. If the registration fails, this method can be used to copy the contents of the failed request into a new request.

Specified by:

createRegistrationRequestFromExisting in interface CourseRegistrationService

Parameters:

registrationRequestId - a RegistrationRequest from which to create the new one

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

Returns:

the new RegistrationRequest

Throws:

DoesNotExistException - registrationRequestId does not exist

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

updateRegistrationRequest

public RegistrationRequestInfo updateRegistrationRequest(String registrationRequestId,
                                                RegistrationRequestInfo registrationRequestInfo,
                                                ContextInfo contextInfo)
                                                  throws DataValidationErrorException,
                                                         DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException,
                                                         ReadOnlyException,
                                                         VersionMismatchException

Description copied from interface: CourseRegistrationService

Updates an existing RegistrationRequest. The RegistrationRequest Id, Type, and Meta information may not be changed.

Specified by:

updateRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestId - the identifier for the RegistrationRequest to be updated

registrationRequestInfo - the new data for the RegistrationRequest

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

Returns:

the updated RegistrationRequest

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - registrationRequestId is not found

InvalidParameterException - registrationRequestInfo or contextInfo is not valid

MissingParameterException - registrationRequestId, registrationRequestInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteRegistrationRequest

public StatusInfo deleteRegistrationRequest(String registrationRequestId,
                                   ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: CourseRegistrationService

Deletes an existing RegistrationRequest.

Specified by:

deleteRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestId - the identifier for the RegistrationRequest to be deleted

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

Returns:

the status of the delete operation. This must always be true.q

Throws:

DoesNotExistException - registrationRequestId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

verifyRegistrationRequestForSubmission

public List<ValidationResultInfo> verifyRegistrationRequestForSubmission(String registrationRequestId,
                                                                ContextInfo contextInfo)
                                                                  throws DoesNotExistException,
                                                                         InvalidParameterException,
                                                                         MissingParameterException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException

Description copied from interface: CourseRegistrationService

Verifies a persisted RegistrationRequest for submission. validateRegistrationRequest() validates the data for persistence of the request itself. This method is intended as a final validation prior to submission and may perform additional checks, such as eligibility, course pre-requisites, and calculating credit load limits.

Specified by:

verifyRegistrationRequestForSubmission in interface CourseRegistrationService

Parameters:

registrationRequestId - an identifier for a RegistrationRequest

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

Returns:

a list of ValidationResults

Throws:

DoesNotExistException - registrationRequestId is not found

InvalidParameterException - contextInfo is not valid

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

MissingParameterException

submitRegistrationRequest

public RegistrationResponseInfo submitRegistrationRequest(String registrationRequestId,
                                                 ContextInfo contextInfo)
                                                   throws AlreadyExistsException,
                                                          DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: CourseRegistrationService

Submits a RegsitrationRequest. This method is transactional and for multiple items, each RegistrationRequestItem must succeed or the entireregistration transaction fails.

Specified by:

submitRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestId - an identifier for a RegistrationRequest

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

Returns:

a RegistrationResponse

Throws:

AlreadyExistsException - When the reg request is already submitted

DoesNotExistException - registrationRequestId is not found

InvalidParameterException - contextInfo is not valid

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

MissingParameterException

getRegistrationRequestItemsForCourseRegistration

public List<RegistrationRequestItemInfo> getRegistrationRequestItemsForCourseRegistration(String courseRegistrationId,
                                                                                 ContextInfo contextInfo)
                                                                                   throws InvalidParameterException,
                                                                                          MissingParameterException,
                                                                                          OperationFailedException,
                                                                                          PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets the RegistrationRequestItems that resulted in or impacted the given CourseRegistration.

Specified by:

getRegistrationRequestItemsForCourseRegistration in interface CourseRegistrationService

Parameters:

courseRegistrationId - an identifier for a CourseRegistration

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

Returns:

list of RegistrationRequests associated with the given CourseRegistration or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - personId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRegistrationRequestItemsByCourseOfferingAndStudent

public List<RegistrationRequestItemInfo> getRegistrationRequestItemsByCourseOfferingAndStudent(String courseOfferingId,
                                                                                      String studentId,
                                                                                      ContextInfo contextInfo)
                                                                                        throws InvalidParameterException,
                                                                                               MissingParameterException,
                                                                                               OperationFailedException,
                                                                                               PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets list of RegistrationRequestItems resulting in or impacting a Student's registration in a CourseOffering.

Specified by:

getRegistrationRequestItemsByCourseOfferingAndStudent in interface CourseRegistrationService

Parameters:

courseOfferingId - an identifier for a CourseOffering

studentId - an identifier for a Student

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

Returns:

list of RegistrationRequests associated with the given CourseOffering or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - courseOfferingId, personId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

checkStudentEligibility

public List<ValidationResultInfo> checkStudentEligibility(String studentId,
                                                 ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: CourseRegistrationService

Checks if a student is eligible to enter the registration process.

Specified by:

checkStudentEligibility in interface CourseRegistrationService

Parameters:

studentId - Identifier of the student

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

Returns:

a list of errors, warnings, or informational messages

Throws:

DoesNotExistException - studentId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

checkStudentEligibilityForTerm

public List<ValidationResultInfo> checkStudentEligibilityForTerm(String studentId,
                                                        String termId,
                                                        ContextInfo contextInfo)
                                                          throws DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Description copied from interface: CourseRegistrationService

Checks the eligibility of a student to register in a particular term.

Specified by:

checkStudentEligibilityForTerm in interface CourseRegistrationService

Parameters:

studentId - an identifier of a Student

termId - an identifier of a Term

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

Returns:

a list of errors, warnings or informational messages

Throws:

DoesNotExistException - studentId or termId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, termId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

checkStudentEligibiltyForCourseOffering

public List<ValidationResultInfo> checkStudentEligibiltyForCourseOffering(String studentId,
                                                                 String courseOfferingId,
                                                                 ContextInfo contextInfo)
                                                                   throws DoesNotExistException,
                                                                          InvalidParameterException,
                                                                          MissingParameterException,
                                                                          OperationFailedException,
                                                                          PermissionDeniedException

Description copied from interface: CourseRegistrationService

Checks if the student is eligible to register for a particular course offering.

Specified by:

checkStudentEligibiltyForCourseOffering in interface CourseRegistrationService

Parameters:

studentId - an identifier of a Student

courseOfferingId - an identifier of a CourseOffering

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

Returns:

a list of errors, warnings or informational messages

Throws:

DoesNotExistException - studentId or courseOfferingId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, courseOfferingId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

checkStudentEligibiltyForRegistrationGroup

public List<ValidationResultInfo> checkStudentEligibiltyForRegistrationGroup(String studentId,
                                                                    String registrationGroupId,
                                                                    ContextInfo contextInfo)
                                                                      throws DoesNotExistException,
                                                                             InvalidParameterException,
                                                                             MissingParameterException,
                                                                             OperationFailedException,
                                                                             PermissionDeniedException

Description copied from interface: CourseRegistrationService

Checks if the student is eligible to register for a particular registration group.

Specified by:

checkStudentEligibiltyForRegistrationGroup in interface CourseRegistrationService

Parameters:

studentId - an identifier of a Student

registrationGroupId - an identifier of a RegistrationGroup

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

Returns:

a list of errors, warnings or informational messages

Throws:

DoesNotExistException - studentId or registrationGroupId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, registrationGroupId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getEligibleRegistrationGroupsForStudentInCourseOffering

public List<RegistrationGroupInfo> getEligibleRegistrationGroupsForStudentInCourseOffering(String studentId,
                                                                                  String courseOfferingId,
                                                                                  ContextInfo contextInfo)
                                                                                    throws DoesNotExistException,
                                                                                           InvalidParameterException,
                                                                                           MissingParameterException,
                                                                                           OperationFailedException,
                                                                                           PermissionDeniedException

Description copied from interface: CourseRegistrationService

Gets the Registration Groups for a CourseOffering for which the given student is eligible to register.

Specified by:

getEligibleRegistrationGroupsForStudentInCourseOffering in interface CourseRegistrationService

Parameters:

studentId - an identifier of a Student

courseOfferingId - an identifier of a CourseOffering

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

Returns:

a list of RegistrationGroups

Throws:

DoesNotExistException - studentId or courseOfferingId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - studentId, courseOfferingId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

calculateCreditLoadForStudentRegistrationRequest

public CreditLoadInfo calculateCreditLoadForStudentRegistrationRequest(String registrationRequestId,
                                                              String studentId,
                                                              ContextInfo contextInfo)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Description copied from interface: CourseRegistrationService

Calculate the credit load for a given student in a given RegistrationRequest.

Specified by:

calculateCreditLoadForStudentRegistrationRequest in interface CourseRegistrationService

Parameters:

registrationRequestId - an identifier of a RegistrationRequest

studentId - an identifier of a Student

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

Returns:

the credit load

Throws:

DoesNotExistException - registrationRequestId is not found or studentId not in RegistrationRequest

InvalidParameterException - contextInfo is not valid

MissingParameterException - registrationRequestId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred