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

Interface CourseRegistrationCartClientService

All Known Implementing Classes:

CourseRegistrationCartClientServiceImpl

public interface CourseRegistrationCartClientService

Services for Registration Cart Operations

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addCoursesToCartRS(String termId, List<AddCourseToCartRequestInfo> cartItems) Adds a list of courses to the cart for the given user and term.
javax.ws.rs.core.Response	addCourseToCartAliasRS(String termId, String regGroupId, String courseCode, String regGroupCode, String gradingOptionId, String credits) Deprecated.
javax.ws.rs.core.Response	addCourseToCartRS(String termId, String regGroupId, String courseCode, String regGroupCode, String gradingOptionId, String credits) The REST version of addCourseToCart
javax.ws.rs.core.Response	clearCartAliasRS(String termId, String termCode) Deprecated.
javax.ws.rs.core.Response	clearCartRS(String termId, String termCode) Find cart if it exists and delete all items from cart.
javax.ws.rs.core.Response	removeItemFromCartRS(String termId, String cartItemId) The REST version of removeItemFromCart
javax.ws.rs.core.Response	searchForCartAliasRS(String termId) Deprecated.
javax.ws.rs.core.Response	searchForCartRS(String termId) Looks up cart information for the given user and term.
javax.ws.rs.core.Response	submitCartAliasRS(String cartId) Deprecated.
javax.ws.rs.core.Response	submitCartRS(String termId) The REST version of submitCart
javax.ws.rs.core.Response	undoDeleteCourseRS(String termId, String courseCode, String regGroupId, String regGroupCode, String gradingOptionId, String credits) The REST version of undoDeleteCourse Calls addCourseToCart logic via a GET Query This is necessary because Undo is a link which does not allow POST operations or have Form Parameters
javax.ws.rs.core.Response	updateCartItemRS(String termId, String cartItemId, String credits, String gradingOptionId) The REST version of updateCartItem

Method Detail

searchForCartRS

javax.ws.rs.core.Response searchForCartRS(String termId)

Looks up cart information for the given user and term. if no cart exists, one is created

Parameters:

termId - term for the cart

Returns:

a Cart Result that contains the courses a student is intending to enroll in for the given term.

clearCartRS

javax.ws.rs.core.Response clearCartRS(String termId,
                                    String termCode)

Find cart if it exists and delete all items from cart.

Parameters:

termId - - optional, but more efficient to use

termCode - - optional, but human readable. 201208

Returns:

submitCartRS

javax.ws.rs.core.Response submitCartRS(String termId)

The REST version of submitCart

Parameters:

termId - ID of the term for the cart

Returns:

A Response containing the Boolean value of TRUE or a server error response.

addCourseToCartRS

javax.ws.rs.core.Response addCourseToCartRS(String termId,
                                          String regGroupId,
                                          String courseCode,
                                          String regGroupCode,
                                          String gradingOptionId,
                                          String credits)

The REST version of addCourseToCart

Parameters:

termId - ID of the term for the cart

courseCode - course offering to add to the cart

regGroupId - Optional. Will speed things up if passed instead of (courseCode, regGroupCode)

regGroupCode - reg group we want to add

gradingOptionId - the RVG key of grading student registration option. (org.kuali.rvg.grading.PassFail, org.kuali.rvg.grading.Letter)

credits - The numeric string value of credit student registration option. Must convert to KualiDecimal.

Returns:

Response containing the cart item that was updated or a server error response.

removeItemFromCartRS

javax.ws.rs.core.Response removeItemFromCartRS(String termId,
                                             String cartItemId)

The REST version of removeItemFromCart

Parameters:

termId - ID of the term for the cart

cartItemId - id of the item to delete from the cart.

Returns:

Response(with add action link) containing the cart item that was updated or a server error response. As Well as action links to undo the removal.

updateCartItemRS

javax.ws.rs.core.Response updateCartItemRS(String termId,
                                         String cartItemId,
                                         String credits,
                                         String gradingOptionId)

The REST version of updateCartItem

Parameters:

termId - ID of the term for the cart

cartItemId - ID of the specific item being updated

credits - The numeric string value of credit student registration option. Must convert to KualiDecimal.

gradingOptionId - the RVG key of grading student registration option. (org.kuali.rvg.grading.PassFail, org.kuali.rvg.grading.Letter)

Returns:

Response containing the cart item that was updated or a server error response.

addCoursesToCartRS

javax.ws.rs.core.Response addCoursesToCartRS(String termId,
                                           List<AddCourseToCartRequestInfo> cartItems)

Adds a list of courses to the cart for the given user and term.

Parameters:

termId - term for the cart

cartItems - List of AddCourseToCartRequestInfo to be added

Returns:

Response containing a list of the cart items that were updated or a server error response.

undoDeleteCourseRS

javax.ws.rs.core.Response undoDeleteCourseRS(String termId,
                                           String courseCode,
                                           String regGroupId,
                                           String regGroupCode,
                                           String gradingOptionId,
                                           String credits)

The REST version of undoDeleteCourse Calls addCourseToCart logic via a GET Query This is necessary because Undo is a link which does not allow POST operations or have Form Parameters

Parameters:

termId - termId for reg group being added to cart

courseCode - course offering to add to the cart

regGroupId - Optional. Will speed things up if passed instead of (courseCode, regGroupCode)

regGroupCode - reg group we want to add

gradingOptionId - the RVG key of grading student registration option. (org.kuali.rvg.grading.PassFail, org.kuali.rvg.grading.Letter)

credits - The numeric string value of credit student registration option. Must convert to KualiDecimal.

Returns:

Response containing the cart item that was updated or a server error response.

clearCartAliasRS

javax.ws.rs.core.Response clearCartAliasRS(String termId,
                                         String termCode)

Deprecated.

Find cart if it exists and delete all items from cart.

Parameters:

termId - - optional, but more efficient to use

termCode - - optional, but human readable. 201208

Returns:

searchForCartAliasRS

javax.ws.rs.core.Response searchForCartAliasRS(String termId)

Deprecated.

Looks up cart information for the given user and term. if no cart exists, one is created

Parameters:

termId - term for the cart

Returns:

a Cart Result that contains the courses a student is intending to enroll in for the given term.

submitCartAliasRS

javax.ws.rs.core.Response submitCartAliasRS(String cartId)

Deprecated.

The REST version of submitCart

Parameters:

cartId - ID of the registrationRequest representing the cart

Returns:

A Response containing the Boolean value of TRUE or a server error response.

addCourseToCartAliasRS

javax.ws.rs.core.Response addCourseToCartAliasRS(String termId,
                                               String regGroupId,
                                               String courseCode,
                                               String regGroupCode,
                                               String gradingOptionId,
                                               String credits)

Deprecated.

The REST version of addCourseToCart

Parameters:

courseCode - course offering to add to the cart

regGroupId - Optional. Will speed things up if passed instead of (courseCode, regGroupCode)

regGroupCode - reg group we want to add

gradingOptionId - the RVG key of grading student registration option. (org.kuali.rvg.grading.PassFail, org.kuali.rvg.grading.Letter)

credits - The numeric string value of credit student registration option. Must convert to KualiDecimal.

Returns:

Response containing the cart item that was updated or a server error response.