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

Interface CourseRegistrationAdminClientService

All Known Implementing Classes:

CourseRegistrationAdminClientServiceImpl

public interface CourseRegistrationAdminClientService

Created with IntelliJ IDEA. User: Charles Date: 7/21/14 Time: 4:02 PM To change this template use File | Settings | File Templates.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearCartByPersonRS(String personId, String termId, String termCode) Find cart if it exists and delete all items from cart.
javax.ws.rs.core.Response	clearLPRsByPersonRS(String personId, String termId, String termCode) Finds all LPRs for a given personId and deletes them.
javax.ws.rs.core.Response	clearRegEngineStats() Clears the overall registration engine stats.
javax.ws.rs.core.Response	getRegEngineStats() Returns statistics for the registration engine.
javax.ws.rs.core.Response	getRoster(String termId, String termCode, String courseCode, String regGroupCode) This method returns a roster of students for a particular registration group.
javax.ws.rs.core.Response	getWaitlistRoster(String termId, String termCode, String courseCode, String regGroupCode) This method returns a roster of students on a waitlist for a particular registration group.

Method Detail

getRegEngineStats

javax.ws.rs.core.Response getRegEngineStats()

Returns statistics for the registration engine.

Returns:

JSON representing various statistics as a JSON-map of elements (ie: entities) where each element contains an array of key-value pairs.

clearRegEngineStats

javax.ws.rs.core.Response clearRegEngineStats()

Clears the overall registration engine stats. It will not clear the MQ stats plugin.

Returns:

Http Response

clearLPRsByPersonRS

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

Finds all LPRs for a given personId and deletes them. If term is passed - deletes LPRs only for that term. Returns a Response object with status.

Parameters:

personId - Principal ID

termId - - optional

termCode - - optional, human readable code representing the term. ex: 201208

Returns:

Empty Response Object or Response object with Error text

clearCartByPersonRS

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

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

Parameters:

personId -

termId - - optional, but more efficient to use

termCode - - optional, but human readable. 201208

Returns:

getWaitlistRoster

javax.ws.rs.core.Response getWaitlistRoster(String termId,
                                          String termCode,
                                          String courseCode,
                                          String regGroupCode)

This method returns a roster of students on a waitlist for a particular registration group.

Parameters:

termId - - optional

termCode - - human readable code representing the term. ex: 201208

courseCode - - human readable code representing the course. ex: CHEM231

regGroupCode - - human readable code representing the reg group. ex: 1001

Returns:

list of WaitlistEntryResult

getRoster

javax.ws.rs.core.Response getRoster(String termId,
                                  String termCode,
                                  String courseCode,
                                  String regGroupCode)

This method returns a roster of students for a particular registration group.

Parameters:

termId - - optional

termCode - - human readable code representing the term. ex: 201208

courseCode - - human readable code representing the course. ex: CHEM231

regGroupCode - - human readable code representing the reg group. ex: 1001

Returns:

Map LprTypeKey is a string that represents the lpr type.