org.kuali.student.lum.lrc.service
Interface LrcService

All Superinterfaces:

DictionaryService, SearchService

All Known Implementing Classes:

LrcServiceImpl

public interface LrcService
extends SearchService, DictionaryService

Method Summary

String	compareGrades(String gradeKey, String scaleKey, String compareGradeKey, String compareScaleKey) Compares a grade value in one scale to a grade value in another scale.
ResultComponentInfo	createResultComponent(String resultComponentTypeKey, ResultComponentInfo resultComponentInfo) Creates a new result component.
StatusInfo	deleteResultComponent(String resultComponentId) Deletes an existing result component.
CredentialInfo	getCredential(String credentialKey) Retrieves information on a specific credential by its identifier.
List<String>	getCredentialKeysByCredentialType(String credentialTypeKey) Retrieves a list of credential identifiers for a specified credential type.
List<CredentialInfo>	getCredentialsByKeyList(List<String> credentialKeyList) Retrieves a list of existing credentials by a list of identifiers.
CredentialTypeInfo	getCredentialType(String credentialTypeKey) Retrieves information on a specific credential type.
List<CredentialTypeInfo>	getCredentialTypes() Retrieves information on all credential types.
CreditInfo	getCredit(String creditKey) Retrieves information on a specific credit value by its identifier.
List<String>	getCreditKeysByCreditType(String creditTypeKey) Retrieves a list of credit identifiers for a specified credit type.
List<CreditInfo>	getCreditsByKeyList(List<String> creditKeyList) Retrieves a list of existing credit values by a list of identifiers.
CreditTypeInfo	getCreditType(String creditTypeKey) Retrieves information on a specific credit type.
List<CreditTypeInfo>	getCreditTypes() Retrieves information on all credit types.
GradeInfo	getGrade(String gradeKey) Retrieves information on a specific grade value by its identifier.
List<String>	getGradeKeysByGradeType(String gradeTypeKey) Retrieves a list of grade identifiers for a specified grade type.
List<GradeInfo>	getGradesByKeyList(List<String> gradeKeyList) Retrieves a list of existing grade values by a list of identifiers.
List<GradeInfo>	getGradesByScale(String scale) Retrieves a list of existing grade values for a particular scale.
GradeTypeInfo	getGradeType(String gradeTypeKey) Retrieves information on a specific grade type.
List<GradeTypeInfo>	getGradeTypes() Retrieves information on all grade types.
ResultComponentInfo	getResultComponent(String resultComponentId) Retrieves information on a specific result component.
List<String>	getResultComponentIdsByResult(String resultValueId, String resultComponentTypeKey) Retrieves a list of result component identifiers for a specified result.
List<String>	getResultComponentIdsByResultComponentType(String resultComponentTypeKey) Retrieves a list of result component identifiers for a specified result component type.
ResultComponentTypeInfo	getResultComponentType(String resultComponentTypeKey) Retrieves information on a specific result component type.
List<ResultComponentTypeInfo>	getResultComponentTypes() Retrieves information on all result component types.
ScaleInfo	getScale(String scaleKey) Retrieves information on a specific scale by its identifier.
List<GradeInfo>	translateGrade(String gradeKey, String scaleKey, String translateScaleKey) Translates a grade value in one scale to equivalent value(s) in another scale.
ResultComponentInfo	updateResultComponent(String resultComponentId, ResultComponentInfo resultComponentInfo) Updates an existing result component.

Methods inherited from interface org.kuali.student.core.search.service.SearchService

getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Methods inherited from interface org.kuali.student.core.dictionary.service.DictionaryService

getObjectStructure, getObjectTypes

Method Detail

getCredentialTypes

List<CredentialTypeInfo> getCredentialTypes()
                                            throws OperationFailedException

Retrieves information on all credential types.

Returns:

list of credential type information

Throws:

OperationFailedException - unable to complete request

getCredentialType

CredentialTypeInfo getCredentialType(String credentialTypeKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Retrieves information on a specific credential type.

Parameters:

credentialTypeKey - identifier for the credential type

Returns:

information about a credential type

Throws:

DoesNotExistException - credentialTypeKey not found

InvalidParameterException - invalid credentialTypeKey

MissingParameterException - missing credentialTypeKey

OperationFailedException - unable to complete request

getCreditTypes

List<CreditTypeInfo> getCreditTypes()
                                    throws OperationFailedException

Retrieves information on all credit types.

Returns:

list of credit type information

Throws:

OperationFailedException - unable to complete request

getCreditType

CreditTypeInfo getCreditType(String creditTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Retrieves information on a specific credit type.

Parameters:

creditTypeKey - identifier for the credit type

Returns:

information about a credit type

Throws:

DoesNotExistException - creditTypeKey not found

InvalidParameterException - invalid creditTypeKey

MissingParameterException - missing creditTypeKey

OperationFailedException - unable to complete request

getGradeTypes

List<GradeTypeInfo> getGradeTypes()
                                  throws OperationFailedException

Retrieves information on all grade types.

Returns:

list of grade type information

Throws:

OperationFailedException - unable to complete request

getGradeType

GradeTypeInfo getGradeType(String gradeTypeKey)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Retrieves information on a specific grade type.

Parameters:

gradeTypeKey - identifier for the grade type

Returns:

information about a grade type

Throws:

DoesNotExistException - gradeTypeKey not found

InvalidParameterException - invalid gradeTypeKey

MissingParameterException - missing gradeTypeKey

OperationFailedException - unable to complete request

getResultComponentTypes

List<ResultComponentTypeInfo> getResultComponentTypes()
                                                      throws OperationFailedException

Retrieves information on all result component types.

Returns:

list of result component type information

Throws:

OperationFailedException - unable to complete request

getResultComponentType

ResultComponentTypeInfo getResultComponentType(String resultComponentTypeKey)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Retrieves information on a specific result component type.

Parameters:

resultComponentTypeKey - result component type key

Returns:

information about a result component type

Throws:

DoesNotExistException - resultComponentTypeKey not found

InvalidParameterException - invalid resultComponentTypeKey

MissingParameterException - missing resultComponentTypeKey

OperationFailedException - unable to complete request

getCredential

CredentialInfo getCredential(String credentialKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Retrieves information on a specific credential by its identifier.

Parameters:

credentialKey - credential identifier

Returns:

information about a credential

Throws:

DoesNotExistException - credentialKey not found

InvalidParameterException - invalid credentialKey

MissingParameterException - missing credentialKey

OperationFailedException - unable to complete request

getCredentialsByKeyList

List<CredentialInfo> getCredentialsByKeyList(List<String> credentialKeyList)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Retrieves a list of existing credentials by a list of identifiers.

Parameters:

credentialKeyList - identifiers for credentials to be retrieved

Returns:

details of the credentials for these ids

Throws:

DoesNotExistException - credentialKey not found

InvalidParameterException - invalid credentialKeyList

MissingParameterException - invalid credentialKeyList

OperationFailedException - unable to complete request

getCredentialKeysByCredentialType

List<String> getCredentialKeysByCredentialType(String credentialTypeKey)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Retrieves a list of credential identifiers for a specified credential type.

Parameters:

credentialTypeKey - identifier for the credential type

Returns:

list of credential identifiers

Throws:

DoesNotExistException - credentialTypeKey not found

InvalidParameterException - invalid credentialTypeKey

MissingParameterException - missing credentialTypeKey

OperationFailedException - unable to complete request

getCredit

CreditInfo getCredit(String creditKey)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException

Retrieves information on a specific credit value by its identifier.

Parameters:

creditKey - credit identifier

Returns:

information about a credit value

Throws:

DoesNotExistException - creditKey not found

InvalidParameterException - invalid creditKey

MissingParameterException - missing creditKey

OperationFailedException - unable to complete request

getCreditsByKeyList

List<CreditInfo> getCreditsByKeyList(List<String> creditKeyList)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Retrieves a list of existing credit values by a list of identifiers.

Parameters:

creditKeyList - identifiers for credit values to be retrieved

Returns:

details of the credit values for these ids

Throws:

DoesNotExistException - creditKey not found

InvalidParameterException - invalid creditKeyList

MissingParameterException - invalid creditKeyList

OperationFailedException - unable to complete request

getCreditKeysByCreditType

List<String> getCreditKeysByCreditType(String creditTypeKey)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves a list of credit identifiers for a specified credit type.

Parameters:

creditTypeKey - identifier for the credit type

Returns:

list of credit identifiers

Throws:

DoesNotExistException - creditTypeKey not found

InvalidParameterException - invalid creditTypeKey

MissingParameterException - missing creditTypeKey

OperationFailedException - unable to complete request

getScale

ScaleInfo getScale(String scaleKey)
                   throws DoesNotExistException,
                          InvalidParameterException,
                          MissingParameterException,
                          OperationFailedException

Retrieves information on a specific scale by its identifier.

Parameters:

scaleKey - scale identifier

Returns:

information about a scale

Throws:

DoesNotExistException - scaleKey not found

InvalidParameterException - invalid scaleKey

MissingParameterException - missing scaleKey

OperationFailedException - unable to complete request

getGrade

GradeInfo getGrade(String gradeKey)
                   throws DoesNotExistException,
                          InvalidParameterException,
                          MissingParameterException,
                          OperationFailedException

Retrieves information on a specific grade value by its identifier.

Parameters:

gradeKey - grade value identifier

Returns:

information about a grade value

Throws:

DoesNotExistException - gradeKey not found

InvalidParameterException - invalid gradeKey

MissingParameterException - missing gradeKey

OperationFailedException - unable to complete request

getGradesByKeyList

List<GradeInfo> getGradesByKeyList(List<String> gradeKeyList)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Retrieves a list of existing grade values by a list of identifiers.

Parameters:

gradeKeyList - identifiers for grade values to be retrieved

Returns:

details of the grade values for these ids

Throws:

DoesNotExistException - gradeKey not found

InvalidParameterException - invalid gradeKeyList

MissingParameterException - invalid gradeKeyList

OperationFailedException - unable to complete request

getGradeKeysByGradeType

List<String> getGradeKeysByGradeType(String gradeTypeKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Retrieves a list of grade identifiers for a specified grade type.

Parameters:

gradeTypeKey - identifier for the grade type

Returns:

list of grade identifiers

Throws:

DoesNotExistException - gradeTypeKey not found

InvalidParameterException - invalid gradeTypeKey

MissingParameterException - missing gradeTypeKey

OperationFailedException - unable to complete request

getGradesByScale

List<GradeInfo> getGradesByScale(String scale)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Retrieves a list of existing grade values for a particular scale.

Parameters:

scale - identifier for the scale

Returns:

details of the grade values for the specified scale

Throws:

DoesNotExistException - scaleKey not found

InvalidParameterException - invalid scaleKey

MissingParameterException - invalid scaleKey

OperationFailedException - unable to complete request

translateGrade

List<GradeInfo> translateGrade(String gradeKey,
                               String scaleKey,
                               String translateScaleKey)
                               throws InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Translates a grade value in one scale to equivalent value(s) in another scale. This may return a single grade value, multiple grade values, or no grade values (in the case of no equivalent values).

Parameters:

gradeKey - identifier of the first grade

scaleKey - scale of the first grade

translateScaleKey - scale of the second grade

Returns:

equivalent grade values for the first grade value in the specified scale

Throws:

InvalidParameterException - invalid gradeKey, scaleKey, or translateScaleKey

MissingParameterException - missing gradeKey, scaleKey, or translateScaleKey

OperationFailedException - unable to complete request

compareGrades

String compareGrades(String gradeKey,
                     String scaleKey,
                     String compareGradeKey,
                     String compareScaleKey)
                     throws InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException

Compares a grade value in one scale to a grade value in another scale.

Parameters:

gradeKey - identifier of the first grade value

scaleKey - scale of the first grade value

compareGradeKey - identifier of the second grade value

compareScaleKey - scale of the second grade value

Returns:

status of the comparison (greater than, less than, equals, not applicable, etc.)

Throws:

InvalidParameterException - invalid gradeKey, scaleKey, compareGradeKey, or compareScaleKey

MissingParameterException - missing gradeKey, scaleKey, compareGradeKey, or compareScaleKey

OperationFailedException - unable to complete request

getResultComponent

ResultComponentInfo getResultComponent(String resultComponentId)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves information on a specific result component.

Parameters:

resultComponentId - result component identifier

Returns:

information about a result component

Throws:

DoesNotExistException - resultComponentId not found

InvalidParameterException - invalid resultComponentId

MissingParameterException - missing resultComponentId

OperationFailedException - unable to complete request

getResultComponentIdsByResultComponentType

List<String> getResultComponentIdsByResultComponentType(String resultComponentTypeKey)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException

Retrieves a list of result component identifiers for a specified result component type.

Parameters:

resultComponentTypeKey - identifier for the result component type

Returns:

list of result component identifiers

Throws:

DoesNotExistException - resultComponentTypeKey not found

InvalidParameterException - invalid resultComponentTypeKey

MissingParameterException - missing resultComponentTypeKey

OperationFailedException - unable to complete request

getResultComponentIdsByResult

List<String> getResultComponentIdsByResult(String resultValueId,
                                           String resultComponentTypeKey)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException

Retrieves a list of result component identifiers for a specified result. The result component type is specified as well to provide an indication of the id space.

Parameters:

resultValueId - identifier for the result value

resultComponentTypeKey - identifier for the result component type

Returns:

list of result component identifiers

Throws:

DoesNotExistException - resultValueId, resultComponentTypeKey not found

InvalidParameterException - invalid resultValueId, resultComponentTypeKey

MissingParameterException - missing resultValueId, resultComponentTypeKey

OperationFailedException - unable to complete request

createResultComponent

ResultComponentInfo createResultComponent(String resultComponentTypeKey,
                                          ResultComponentInfo resultComponentInfo)
                                          throws AlreadyExistsException,
                                                 DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Creates a new result component.

Parameters:

resultComponentTypeKey - identifier of the result component type

resultComponentInfo - information about the result component being created

Returns:

create result component information

Throws:

AlreadyExistsException - result component already exists

DataValidationErrorException - one or more values invalid for this operation

DoesNotExistException - resultComponentTypeKey not found

InvalidParameterException - invalid resultComponentTypeKey, resultComponentInfo

MissingParameterException - missing resultComponentTypeKey, resultComponentInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateResultComponent

ResultComponentInfo updateResultComponent(String resultComponentId,
                                          ResultComponentInfo resultComponentInfo)
                                          throws DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException,
                                                 VersionMismatchException

Updates an existing result component.

Parameters:

resultComponentId - identifier of the result component to update

resultComponentInfo - updated information about the result component

Returns:

updated result component information

Throws:

DataValidationErrorException - one or more values invalid for this operation

DoesNotExistException - resultComponentId not found

InvalidParameterException - invalid resultComponentId, resultComponentInfo

MissingParameterException - missing resultComponentId, resultComponentInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

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

deleteResultComponent

StatusInfo deleteResultComponent(String resultComponentId)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Deletes an existing result component.

Parameters:

resultComponentId - identifier of the result component to update

Returns:

status of the operation

Throws:

DoesNotExistException - resultComponentId not found

InvalidParameterException - invalid resultComponentId

MissingParameterException - missing resultComponentId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure