org.kuali.student.enrollment.exam.service

Interface ExamService

All Known Implementing Classes:

ExamServiceDecorator, ExamServiceImpl, ExamServiceMapImpl, ExamServiceValidationDecorator

public interface ExamService

Created with IntelliJ IDEA. User: Mezba Mahtab (mezba.mahtab@utoronto.ca) Date: 1/17/13 Time: 3:11 PM Represents a canonical exam service.

Method Summary

Methods

Modifier and Type	Method and Description
ExamInfo	createExam(String examTypeKey, ExamInfo examInfo, ContextInfo contextInfo) Creates a new Exam.
StatusInfo	deleteExam(String examId, ContextInfo contextInfo) Deletes an existing exam.
ExamInfo	getExam(String examId, ContextInfo contextInfo) Retrieves information about an exam.
List<String>	getExamIdsByType(String examTypeKey, ContextInfo contextInfo) Retrieve a list of Exam Ids by Exam Type.
List<ExamInfo>	getExamsByIds(List<String> examIds, ContextInfo contextInfo) Retrieves the information for the specified list of Exams (that match the given Ids).
List<String>	searchForExamIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Exams that meet the given search criteria.
List<ExamInfo>	searchForExams(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Exams that meet the given search criteria.
ExamInfo	updateExam(String examId, ExamInfo examInfo, ContextInfo contextInfo) Updates an existing exam.
List<ValidationResultInfo>	validateExam(String validationTypeKey, String examTypeKey, ExamInfo examInfo, ContextInfo contextInfo) Validates an Exam.

Method Detail

validateExam

List<ValidationResultInfo> validateExam(String validationTypeKey,
                                      String examTypeKey,
                                      ExamInfo examInfo,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

validationTypeKey - the identifier for the validation Type

examTypeKey - the identifier for the exam type to be validated

examInfo - the exam to be validated

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

Returns:

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

Throws:

DoesNotExistException - validationTypeKey or examTypeKey is not found

InvalidParameterException - examInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, examTypeKey, examInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createExam

ExamInfo createExam(String examTypeKey,
                  ExamInfo examInfo,
                  ContextInfo contextInfo)
                    throws DataValidationErrorException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           ReadOnlyException

Creates a new Exam.

Parameters:

examTypeKey - a unique identifier for the Type of the new exam

examInfo - the data with which to create the exam

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

Returns:

the new exam created

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - examTypeKey does not exist or is not supported

InvalidParameterException - examInfo or contextInfo is not valid

MissingParameterException - examTypeKey, examInfo, 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

getExam

ExamInfo getExam(String examId,
               ContextInfo contextInfo)
                 throws DoesNotExistException,
                        InvalidParameterException,
                        MissingParameterException,
                        OperationFailedException,
                        PermissionDeniedException

Retrieves information about an exam.

Parameters:

examId - the id of the exam

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

Returns:

an exam whose id matches the given id

Throws:

DoesNotExistException - if the exam does not exist

InvalidParameterException - contextInfo is invalid

MissingParameterException - examId or contextInfo are absent (missing or null)

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occured

updateExam

ExamInfo updateExam(String examId,
                  ExamInfo examInfo,
                  ContextInfo contextInfo)
                    throws DataValidationErrorException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           ReadOnlyException,
                           VersionMismatchException

Updates an existing exam.

Parameters:

examId - the identifier for the exam to be updated

examInfo - the new data for the exam

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

Returns:

the updated object

Throws:

DataValidationErrorException - supplied data is invalid (xml)

DoesNotExistException - examId is not found

InvalidParameterException - examInfo or contextInfo is not valid

MissingParameterException - examId, examInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt was made to change information designated as read only

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

deleteExam

StatusInfo deleteExam(String examId,
                    ContextInfo contextInfo)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Deletes an existing exam.

Parameters:

examId - the identifier for the exam to be deleted

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

Returns:

the status of the operation

Throws:

DoesNotExistException - examId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - examId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getExamsByIds

List<ExamInfo> getExamsByIds(List<String> examIds,
                           ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Retrieves the information for the specified list of Exams (that match the given Ids).

Parameters:

examIds - List of identifiers for exams

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

Returns:

List of exams matching the given ids

Throws:

DoesNotExistException - One or more exams not found

InvalidParameterException - contextInfo is invalid

MissingParameterException - examIds or contextInfo are absent (missing or null)

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getExamIdsByType

List<String> getExamIdsByType(String examTypeKey,
                            ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Retrieve a list of Exam Ids by Exam Type.

Parameters:

examTypeKey - the identifier for an exam Type

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

Returns:

a list of exam identifiers matching examTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - examTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForExamIds

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

Searches for Exams that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of Exam Ids matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForExams

List<ExamInfo> searchForExams(QueryByCriteria criteria,
                            ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Searches for Exams that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of Exams matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred