org.kuali.student.enrollment.lrr.service
Interface LearningResultRecordService

All Known Implementing Classes:

LearningResultRecordServiceDecorator, LearningResultRecordServiceImpl

public interface LearningResultRecordService

The Learning Result Record Service supports the management of results earned through a person's participation in a learning unit instance.

Author:

Kuali Student Team (Kamal)

Method Summary

LearningResultRecordInfo	createLearningResultRecord(LearningResultRecordInfo learningResultRecord, ContextInfo context) Creates an learning result record.
ResultSourceInfo	createResultSource(ResultSourceInfo sourceInfo, ContextInfo context) Create a new result source
StatusInfo	deleteLearningResultRecord(String learningResultRecordId, ContextInfo context) Deletes an learning result record
StatusInfo	deleteResultSource(String resultSourceId, ContextInfo context) Delete a result source.
LearningResultRecordInfo	getLearningResultRecord(String learningResultRecordId, ContextInfo context) Retrieves a learning result record by its identifier
List<LearningResultRecordInfo>	getLearningResultRecordsBySourceId(List<String> sourceIds, ContextInfo context) Retrieves a list of learning result records by source Id
List<LearningResultRecordInfo>	getLearningResultRecordsForLpr(String lprId) Retrieves a list of learning result records for a Lui Person Relation
List<LearningResultRecordInfo>	getLearningResultRecordsForLprAndType(String lprId, String lrrType) Retrieves a list of learning result records based on LPR and the type of LRR
List<LearningResultRecordInfo>	getLearningResultRecordsForLprIds(List<String> lprIds, ContextInfo context) Retrieves a list of learning result records for Lui Person Relation Ids
ResultSourceInfo	getResultSource(String resultSourceId, ContextInfo context) Retrieves a result source for a given identifier
List<ResultSourceInfo>	getResultSourcesByIds(List<String> resultSourceIds, ContextInfo context) Retrieves a list of result sources for a list of Ids
List<ResultSourceInfo>	getResultSourcesByType(String resultSourceTypeKey, ContextInfo context) Retrieves a list of result sources by type
LearningResultRecordInfo	updateLearningResultRecord(String learningResultRecordId, LearningResultRecordInfo learningResultRecordInfo, ContextInfo context) Updates an learning result record
ResultSourceInfo	updateResultSource(String resultSourceId, ResultSourceInfo resultSourceInfo, ContextInfo context) Updates a result source
List<ValidationResultInfo>	validateLearningResultRecord(String validationType, LearningResultRecordInfo learningResultRecordInfo, ContextInfo context) Validates an learning result record.
List<ValidationResultInfo>	validateResultSource(String validationType, ResultSourceInfo resultSourceInfo, ContextInfo context) Validates a result source

Method Detail

getLearningResultRecord

LearningResultRecordInfo getLearningResultRecord(String learningResultRecordId,
                                                 ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves a learning result record by its identifier

Parameters:

learningResultRecordId - learning result record identifier

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

Returns:

learning result record information

Throws:

DoesNotExistException - learning result record not found

InvalidParameterException - invalid learningResultRecordId

MissingParameterException - learningResultRecordId not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLearningResultRecordsForLpr

List<LearningResultRecordInfo> getLearningResultRecordsForLpr(String lprId)
                                                              throws DoesNotExistException,
                                                                     InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException

Retrieves a list of learning result records for a Lui Person Relation

Parameters:

lprId - Lui person relation identifier

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

Returns:

list of learning result record information

Throws:

DoesNotExistException - person not found

InvalidParameterException - invalid personId

MissingParameterException - personId not specified

OperationFailedException - unable to complete request

getLearningResultRecordsForLprAndType

List<LearningResultRecordInfo> getLearningResultRecordsForLprAndType(String lprId,
                                                                     String lrrType)
                                                                     throws DoesNotExistException,
                                                                            InvalidParameterException,
                                                                            MissingParameterException,
                                                                            OperationFailedException

Retrieves a list of learning result records based on LPR and the type of LRR

Parameters:

lprId -

lrrType -

Returns:

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

getLearningResultRecordsForLprIds

List<LearningResultRecordInfo> getLearningResultRecordsForLprIds(List<String> lprIds,
                                                                 ContextInfo context)
                                                                 throws DoesNotExistException,
                                                                        InvalidParameterException,
                                                                        MissingParameterException,
                                                                        OperationFailedException

Retrieves a list of learning result records for Lui Person Relation Ids

Parameters:

lprIds - List of Lui person relation identifier

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

Returns:

list of learning result record information

Throws:

DoesNotExistException - person not found

InvalidParameterException - invalid personId

MissingParameterException - personId not specified

OperationFailedException - unable to complete request

getLearningResultRecordsBySourceId

List<LearningResultRecordInfo> getLearningResultRecordsBySourceId(List<String> sourceIds,
                                                                  ContextInfo context)
                                                                  throws DoesNotExistException,
                                                                         InvalidParameterException,
                                                                         MissingParameterException,
                                                                         OperationFailedException

Retrieves a list of learning result records by source Id

Parameters:

lprIds - List of Lui person relation identifier

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

Returns:

list of learning result record information

Throws:

DoesNotExistException - person not found

InvalidParameterException - invalid personId

MissingParameterException - personId not specified

OperationFailedException - unable to complete request

createLearningResultRecord

LearningResultRecordInfo createLearningResultRecord(LearningResultRecordInfo learningResultRecord,
                                                    ContextInfo context)
                                                    throws AlreadyExistsException,
                                                           DataValidationErrorException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Creates an learning result record.

Parameters:

learningResultRecordInfo - information about the learning result record

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

Returns:

information about the newly created learning result record

Throws:

AlreadyExistsException - Learning result record already exists

DataValidationErrorException - One or more values invalid for this operation

InvalidParameterException - one or more parameters invalid

MissingParameterException - one or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateLearningResultRecord

LearningResultRecordInfo updateLearningResultRecord(String learningResultRecordId,
                                                    LearningResultRecordInfo learningResultRecordInfo,
                                                    ContextInfo context)
                                                    throws DataValidationErrorException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           VersionMismatchException

Updates an learning result record

Parameters:

learningResultRecordId - identifier of the learning result record to be updated

learningResultRecordInfo - information about the learningResultRecord to be updated

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

Returns:

the updated learning result record information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - learning result record not found

InvalidParameterException - one or more parameters invalid

MissingParameterException - one or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

deleteLearningResultRecord

StatusInfo deleteLearningResultRecord(String learningResultRecordId,
                                      ContextInfo context)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Deletes an learning result record

Parameters:

learningResultRecordId - identifier of the learning result record to delete

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

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - learning result record not found

InvalidParameterException - invalid learningResultRecordId

MissingParameterException - missing learningResultRecordId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateLearningResultRecord

List<ValidationResultInfo> validateLearningResultRecord(String validationType,
                                                        LearningResultRecordInfo learningResultRecordInfo,
                                                        ContextInfo context)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException

Validates an learning result record. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the learning result record (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the learning result record can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Parameters:

validationType - identifier of the extent of validation

learningResultRecordInfo - learning result record information to be tested.

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

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, learningResultRecordInfo

MissingParameterException - missing validationTypeKey, learningResultRecordInfo

OperationFailedException - unable to complete request

getResultSource

ResultSourceInfo getResultSource(String resultSourceId,
                                 ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Retrieves a result source for a given identifier

Parameters:

resultSourceId - result source id

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

Returns:

learning result record information

Throws:

DoesNotExistException - result source not found

InvalidParameterException - invalid resultSourceId

MissingParameterException - resultSourceId not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultSourcesByIds

List<ResultSourceInfo> getResultSourcesByIds(List<String> resultSourceIds,
                                             ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Retrieves a list of result sources for a list of Ids

Parameters:

resultSourceIds - result source Id list

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

Returns:

list of result sources

Throws:

DoesNotExistException - result source not found

InvalidParameterException - invalid resultSourceIds

MissingParameterException - resultSourceIds not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultSourcesByType

List<ResultSourceInfo> getResultSourcesByType(String resultSourceTypeKey,
                                              ContextInfo context)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Retrieves a list of result sources by type

Parameters:

resultSourceTypeKey - result source type key

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

Returns:

list of result sources

Throws:

DoesNotExistException - result source not found

InvalidParameterException - invalid resultSourceTypeKey

MissingParameterException - resultSourceTypeKey not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createResultSource

ResultSourceInfo createResultSource(ResultSourceInfo sourceInfo,
                                    ContextInfo context)
                                    throws AlreadyExistsException,
                                           DataValidationErrorException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Create a new result source

Parameters:

learningResultRecordId - learning result record identifier

sourceInfo - source information

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

Throws:

AlreadyExistsException - the result source being created already exists

DataValidationErrorException - One or more values invalid for this operation

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateResultSource

ResultSourceInfo updateResultSource(String resultSourceId,
                                    ResultSourceInfo resultSourceInfo,
                                    ContextInfo context)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           VersionMismatchException

Updates a result source

Parameters:

resultSourceId - source identifier

resultSourceInfo - source information

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

Returns:

updated result source information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - result source not found

InvalidParameterException - invalid resultSourceId or resultSourceInfo

MissingParameterException - resultSourceId or resultSourceInfo not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version

deleteResultSource

StatusInfo deleteResultSource(String resultSourceId,
                              ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Delete a result source. The result source should not be deleteable if it is still being referenced by any LRR

Parameters:

sourceId - source information identifier

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

Returns:

status

Throws:

DoesNotExistException - the result source does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateResultSource

List<ValidationResultInfo> validateResultSource(String validationType,
                                                ResultSourceInfo resultSourceInfo,
                                                ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Validates a result source

Parameters:

validationType - identifier of the extent of validation

resultSourceInfo - result source information to be tested.

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

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, resultSourceInfo

MissingParameterException - missing validationTypeKey, resultSourceInfo

OperationFailedException - unable to complete request