org.kuali.student.r2.lum.lrc.service.impl
Class LRCServiceImpl

java.lang.Object
  org.kuali.student.r2.lum.lrc.service.impl.LRCServiceImpl

All Implemented Interfaces:

SearchService, LRCService, LrcServiceBusinessLogic

public class LRCServiceImpl
extends Object
implements LRCService

Constructor Summary

LRCServiceImpl()

Method Summary

ResultScaleInfo	createResultScale(String typeKey, ResultScaleInfo info, ContextInfo contextInfo) Creates a new result scale.
ResultValueInfo	createResultValue(String resultScaleKey, String typeKey, ResultValueInfo info, ContextInfo contextInfo) Create a new result value
ResultValuesGroupInfo	createResultValuesGroup(String resultScaleKey, String typeKey, ResultValuesGroupInfo info, ContextInfo contextInfo) Creates a new result Values Group.
StatusInfo	deleteResultScale(String key, ContextInfo contextInfo) Deletes an existing result scale.
StatusInfo	deleteResultValue(String key, ContextInfo contextInfo) Delete a result value.
StatusInfo	deleteResultValuesGroup(String key, ContextInfo contextInfo) Deletes an existing result values group.
ResultValuesGroupInfo	getCreateFixedCreditResultValuesGroup(String creditValue, String scaleKey, ContextInfo context) Get or create a new result values group holding the specified number of credits The resulting RVG should have a type of FIXED May also create the corresponding credit value.
ResultValuesGroupInfo	getCreateMultipleCreditResultValuesGroup(List<String> creditValues, String scaleKey, ContextInfo context) Get or create a new result values group holding the specified number of credits The resulting RVG should have the type of MULTIPLE
ResultValuesGroupInfo	getCreateRangeCreditResultValuesGroup(String creditValueMin, String creditValueMax, String creditValueIncrement, String scaleKey, ContextInfo context) Get or create a new result values group holding the specified number of credits The resulting RVG will have a type of RANGE
ResultValueInfo	getCreateResultValueForScale(String resultValue, String scaleKey, ContextInfo context) Get or create a new result value holding the specified numeric value within the range The resulting result value should be attached to the specified group and must be within the range of the group
LrcServiceBusinessLogic	getLrcServiceBusinessLogic()
ResultScaleInfo	getResultScale(String key, ContextInfo contextInfo) Retrieves result scale by an identifier.
CriteriaLookupService	getResultScaleCriteriaLookupService()
ResultScaleDao	getResultScaleDao()
List<String>	getResultScaleKeysByType(String resultScaleTypeKey, ContextInfo contextInfo) Retrieves a list of result group identifiers for a specified result scale type.
List<ResultScaleInfo>	getResultScalesByKeys(List<String> keys, ContextInfo contextInfo) Retrieves result scales by a list of identifiers.
ResultValueInfo	getResultValue(String key, ContextInfo contextInfo) Retrieves result value by its id.
CriteriaLookupService	getResultValueCriteriaLookupService()
ResultValueDao	getResultValueDao()
ResultValueInfo	getResultValueForScaleAndValue(String resultScaleKey, String value, ContextInfo contextInfo) Retrieves a result value by result scale key and value
List<String>	getResultValueKeysByType(String resultValueTypeKey, ContextInfo contextInfo) Retrieves a list of result values by type.
List<ResultValueInfo>	getResultValuesByKeys(List<String> keys, ContextInfo contextInfo) Retrieves a list of result value objects for a list of identifiers.
List<ResultValueInfo>	getResultValuesForResultValuesGroup(String resultValuesGroupKey, ContextInfo contextInfo) Retrieves a list of result value objects for a specified result values group.
List<ResultValueInfo>	getResultValuesForResultValuesGroups(List<String> resultValuesGroupKeys, ContextInfo contextInfo) Retrieves result values for the list of Result values groups.
List<ResultValueInfo>	getResultValuesForScale(String resultScaleKey, ContextInfo contextInfo) Retrieves result values by result scale key.
ResultValuesGroupInfo	getResultValuesGroup(String key, ContextInfo contextInfo) Retrieves existing result values group by an identifier.
CriteriaLookupService	getResultValuesGroupCriteriaLookupService()
ResultValuesGroupDao	getResultValuesGroupDao()
List<String>	getResultValuesGroupKeysByType(String resultValuesGroupTypeKey, ContextInfo contextInfo) Retrieves a list of result group identifiers for a specified result values group type.
List<ResultValuesGroupInfo>	getResultValuesGroupsByKeys(List<String> keys, ContextInfo contextInfo) Retrieves result values groups by a list of identifiers.
List<ResultValuesGroupInfo>	getResultValuesGroupsByResultScale(String resultScaleKey, ContextInfo contextInfo) Retrieves a list of existing result values groups that a result scale is tied to.
List<ResultValuesGroupInfo>	getResultValuesGroupsByResultScaleType(String resultScaleTypeKey, ContextInfo contextInfo) Retrieves a list of existing result values groups that have a scale of the specified type.
List<ResultValuesGroupInfo>	getResultValuesGroupsByResultValue(String resultValueKey, ContextInfo contextInfo) Retrieves a list of existing result values groups that a result value is tied to.
SearchManager	getSearchManager()
TypeInfo	getSearchType(String searchTypeKey, ContextInfo contextInfo) Retrieves information about a particular search type.
List<TypeInfo>	getSearchTypes(ContextInfo contextInfo) Retrieves the list of search types known by this service.
SearchResultInfo	search(SearchRequestInfo searchRequest, ContextInfo contextInfo) Performs a search.
List<String>	searchForResultScaleIds(QueryByCriteria criteria, ContextInfo context) Searches for result scale ids using a free form search criteria.
List<ResultScaleInfo>	searchForResultScales(QueryByCriteria criteria, ContextInfo context) Searches for result scales using a free form search criteria
List<String>	searchForResultValueIds(QueryByCriteria criteria, ContextInfo context) Searches for result value ids using a free form search criteria.
List<ResultValueInfo>	searchForResultValues(QueryByCriteria criteria, ContextInfo context) Searches for result values using a free form search criteria
List<String>	searchForResultValuesGroupIds(QueryByCriteria criteria, ContextInfo context) Searches for result value group ids using a free form search criteria.
List<ResultValuesGroupInfo>	searchForResultValuesGroups(QueryByCriteria criteria, ContextInfo context) Searches for result value groups using a free form search criteria
void	setLrcServiceBusinessLogic(LrcServiceBusinessLogic lrcServiceBusinessLogic)
void	setResultScaleCriteriaLookupService(CriteriaLookupService resultScaleCriteriaLookupService)
void	setResultScaleDao(ResultScaleDao resultScaleDao)
void	setResultValueCriteriaLookupService(CriteriaLookupService resultValueCriteriaLookupService)
void	setResultValueDao(ResultValueDao resultValueDao)
void	setResultValuesGroupCriteriaLookupService(CriteriaLookupService resultValuesGroupCriteriaLookupService)
void	setResultValuesGroupDao(ResultValuesGroupDao resultValuesGroupDao)
void	setSearchManager(SearchManager searchManager)
ResultScaleInfo	updateResultScale(String key, ResultScaleInfo info, ContextInfo contextInfo) Updates an existing result scale.
ResultValueInfo	updateResultValue(String key, ResultValueInfo info, ContextInfo contextInfo) Update a result value
ResultValuesGroupInfo	updateResultValuesGroup(String key, ResultValuesGroupInfo info, ContextInfo contextInfo) Updates an existing result values group.
List<ValidationResultInfo>	validateResultScale(String validationType, ResultScaleInfo gradeScaleInfo, ContextInfo contextInfo) Validates a result scale.
List<ValidationResultInfo>	validateResultValue(String validationType, ResultValueInfo resultValueInfo, ContextInfo contextInfo) Validates a Result Value.
List<ValidationResultInfo>	validateResultValuesGroup(String validationType, ResultValuesGroupInfo gradeValuesGroupInfo, ContextInfo contextInfo) Validates a result values group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LRCServiceImpl

public LRCServiceImpl()

Method Detail

getSearchManager

public SearchManager getSearchManager()

setSearchManager

public void setSearchManager(SearchManager searchManager)

getLrcServiceBusinessLogic

public LrcServiceBusinessLogic getLrcServiceBusinessLogic()

setLrcServiceBusinessLogic

public void setLrcServiceBusinessLogic(LrcServiceBusinessLogic lrcServiceBusinessLogic)

getResultScaleDao

public ResultScaleDao getResultScaleDao()

setResultScaleDao

public void setResultScaleDao(ResultScaleDao resultScaleDao)

getResultValueDao

public ResultValueDao getResultValueDao()

setResultValueDao

public void setResultValueDao(ResultValueDao resultValueDao)

getResultValuesGroupDao

public ResultValuesGroupDao getResultValuesGroupDao()

setResultValuesGroupDao

public void setResultValuesGroupDao(ResultValuesGroupDao resultValuesGroupDao)

getResultScaleCriteriaLookupService

public CriteriaLookupService getResultScaleCriteriaLookupService()

setResultScaleCriteriaLookupService

public void setResultScaleCriteriaLookupService(CriteriaLookupService resultScaleCriteriaLookupService)

getResultValueCriteriaLookupService

public CriteriaLookupService getResultValueCriteriaLookupService()

setResultValueCriteriaLookupService

public void setResultValueCriteriaLookupService(CriteriaLookupService resultValueCriteriaLookupService)

getResultValuesGroupCriteriaLookupService

public CriteriaLookupService getResultValuesGroupCriteriaLookupService()

setResultValuesGroupCriteriaLookupService

public void setResultValuesGroupCriteriaLookupService(CriteriaLookupService resultValuesGroupCriteriaLookupService)

createResultScale

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultScaleInfo createResultScale(String typeKey,
                                                                                                                                           ResultScaleInfo info,
                                                                                                                                           ContextInfo contextInfo)
                                  throws AlreadyExistsException,
                                         DataValidationErrorException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: LRCService

Creates a new result scale.

Specified by:

createResultScale in interface LRCService

Parameters:

typeKey - type key of the result scale

info - information about the result scale being created

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

Returns:

create result scale information

Throws:

AlreadyExistsException - result scale already exists

DataValidationErrorException - one or more values invalid for this operation

InvalidParameterException - invalid resultScaleInfo

MissingParameterException - missing resultScaleInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createResultValue

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValueInfo createResultValue(String resultScaleKey,
                                                                                                                                           String typeKey,
                                                                                                                                           ResultValueInfo info,
                                                                                                                                           ContextInfo contextInfo)
                                  throws AlreadyExistsException,
                                         DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: LRCService

Create a new result value

Specified by:

createResultValue in interface LRCService

Parameters:

resultScaleKey - scale to which this value is attached

typeKey - type of the result value to be created

info - info about the result value

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

Returns:

newly created resultValue

Throws:

AlreadyExistsException - resultValue already exists

DataValidationErrorException - one or more values invalid for this operation

InvalidParameterException - invalid resultValueInfo

MissingParameterException - missing resultValueInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DoesNotExistException

createResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValuesGroupInfo createResultValuesGroup(String resultScaleKey,
                                                                                                                                                       String typeKey,
                                                                                                                                                       ResultValuesGroupInfo info,
                                                                                                                                                       ContextInfo contextInfo)
                                              throws AlreadyExistsException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Description copied from interface: LRCService

Creates a new result Values Group.

Specified by:

createResultValuesGroup in interface LRCService

info - information about the result values group being created

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

Returns:

create result values group information

Throws:

AlreadyExistsException - result values group already exists

DataValidationErrorException - one or more values invalid for this operation

InvalidParameterException - invalid resultValuesGroupInfo

MissingParameterException - missing resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteResultScale

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteResultScale(String key,
                                                                                                                                      ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    DependentObjectsExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Description copied from interface: LRCService

Deletes an existing result scale.

Specified by:

deleteResultScale in interface LRCService

Parameters:

key - identifier of the result scale to update

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

Returns:

status of the operation

Throws:

DoesNotExistException - resultScaleKey not found

DependentObjectsExistException - if a group or value exists for this scale

InvalidParameterException - invalid resultScaleKey

MissingParameterException - missing resultScaleKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteResultValue

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteResultValue(String key,
                                                                                                                                      ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    DependentObjectsExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Description copied from interface: LRCService

Delete a result value. This should not be allowed if any result values group is still referencing the result value.

Specified by:

deleteResultValue in interface LRCService

Parameters:

key - result value to be deleted

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

Returns:

status of the delete operation

Throws:

DoesNotExistException - resultValueKey does not exist

DependentObjectsExistException - if a group is tied to this value

InvalidParameterException - invalid resultValueKey

MissingParameterException - missing resultValueKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteResultValuesGroup(String key,
                                                                                                                                            ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: LRCService

Deletes an existing result values group.

Specified by:

deleteResultValuesGroup in interface LRCService

Parameters:

key - identifier of the result values group to update

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

Returns:

status of the operation

Throws:

DoesNotExistException - resultValuesGroupKey not found

InvalidParameterException - invalid resultValuesGroupKey

MissingParameterException - missing resultValuesGroupKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCreateFixedCreditResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValuesGroupInfo getCreateFixedCreditResultValuesGroup(String creditValue,
                                                                                                                                                                     String scaleKey,
                                                                                                                                                                     ContextInfo context)
                                                            throws InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Description copied from interface: LRCService

Get or create a new result values group holding the specified number of credits The resulting RVG should have a type of FIXED May also create the corresponding credit value.

Specified by:

getCreateFixedCreditResultValuesGroup in interface LRCService

Specified by:

getCreateFixedCreditResultValuesGroup in interface LrcServiceBusinessLogic

Parameters:

creditValue - the credit value to be found/created

scaleKey - the scale associated with this type of credit (regular or remedial or continuing ed, etc)

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

Returns:

create result values group information

Throws:

InvalidParameterException - invalid resultValuesGroupInfo

MissingParameterException - missing resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCreateRangeCreditResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValuesGroupInfo getCreateRangeCreditResultValuesGroup(String creditValueMin,
                                                                                                                                                                     String creditValueMax,
                                                                                                                                                                     String creditValueIncrement,
                                                                                                                                                                     String scaleKey,
                                                                                                                                                                     ContextInfo context)
                                                            throws InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Description copied from interface: LRCService

Get or create a new result values group holding the specified number of credits The resulting RVG will have a type of RANGE

Specified by:

getCreateRangeCreditResultValuesGroup in interface LRCService

Specified by:

getCreateRangeCreditResultValuesGroup in interface LrcServiceBusinessLogic

Parameters:

creditValueMin - the minimum credit value of the range to be found/created

creditValueMax - the maximum credit value to be found/created

creditValueIncrement - the credit value increment of the range to be found/created

scaleKey - the scale associated with this type of credit (regular or remedial or continuing ed, etc)

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

Returns:

create result values group information

Throws:

InvalidParameterException - invalid resultValuesGroupInfo

MissingParameterException - missing resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCreateMultipleCreditResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValuesGroupInfo getCreateMultipleCreditResultValuesGroup(List<String> creditValues,
                                                                                                                                                                        String scaleKey,
                                                                                                                                                                        ContextInfo context)
                                                               throws InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Description copied from interface: LRCService

Get or create a new result values group holding the specified number of credits The resulting RVG should have the type of MULTIPLE

Specified by:

getCreateMultipleCreditResultValuesGroup in interface LRCService

Specified by:

getCreateMultipleCreditResultValuesGroup in interface LrcServiceBusinessLogic

Parameters:

creditValues - the minimum credit value of the range to be found/created

scaleKey - the scale associated with this type of credit (regular or remedial or continuing ed, etc)

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

Returns:

create result values group information

Throws:

InvalidParameterException - invalid resultValuesGroupInfo

MissingParameterException - missing resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCreateResultValueForScale

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValueInfo getCreateResultValueForScale(String resultValue,
                                                                                                                                                      String scaleKey,
                                                                                                                                                      ContextInfo context)
                                             throws InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Description copied from interface: LRCService

Get or create a new result value holding the specified numeric value within the range The resulting result value should be attached to the specified group and must be within the range of the group

Specified by:

getCreateResultValueForScale in interface LRCService

Specified by:

getCreateResultValueForScale in interface LrcServiceBusinessLogic

Parameters:

resultValue - the result value within the specified group range to be found/created

scaleKey - the with associated with this value

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

Returns:

the result value group information

Throws:

InvalidParameterException - invalid scaleKey or scaleKey is not a range

MissingParameterException - missing resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultScale

@Transactional(readOnly=true)
public ResultScaleInfo getResultScale(String key,
                                                            ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: LRCService

Retrieves result scale by an identifier.

Specified by:

getResultScale in interface LRCService

Parameters:

key - identifiers for result scale to be retrieved

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

Returns:

details of the result scale for the id

Throws:

DoesNotExistException - resultValuesGroupKey not found

InvalidParameterException - invalid resultValuesGroupKey

MissingParameterException - invalid resultValuesGroupKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultScaleKeysByType

@Transactional(readOnly=true)
public List<String> getResultScaleKeysByType(String resultScaleTypeKey,
                                                                   ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of result group identifiers for a specified result scale type.

Specified by:

getResultScaleKeysByType in interface LRCService

Parameters:

resultScaleTypeKey - identifier for the result group type

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

Returns:

list of result group identifiers

Throws:

DoesNotExistException - resultScaleTypeKey not found

InvalidParameterException - invalid resultScaleTypeKey

MissingParameterException - missing resultScaleTypeKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultScalesByKeys

@Transactional(readOnly=true)
public List<ResultScaleInfo> getResultScalesByKeys(List<String> keys,
                                                                         ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LRCService

Retrieves result scales by a list of identifiers.

Specified by:

getResultScalesByKeys in interface LRCService

Parameters:

keys - identifiers for result scale

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

Returns:

result scale list

Throws:

DoesNotExistException - resultScale not found

InvalidParameterException - invalid resultScaleKeys

MissingParameterException - invalid resultScaleKeys

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValue

@Transactional(readOnly=true)
public ResultValueInfo getResultValue(String key,
                                                            ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: LRCService

Retrieves result value by its id.

Specified by:

getResultValue in interface LRCService

Parameters:

key - identifier for the result

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

Returns:

details about a result value

Throws:

DoesNotExistException - the resultValueKey is not found

InvalidParameterException - invalid resultValueKey

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValueForScaleAndValue

@Transactional(readOnly=true)
public ResultValueInfo getResultValueForScaleAndValue(String resultScaleKey,
                                                                            String value,
                                                                            ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Description copied from interface: LRCService

Retrieves a result value by result scale key and value

Specified by:

getResultValueForScaleAndValue in interface LRCService

Parameters:

resultScaleKey - key to the scale

value - the specific value

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

Returns:

the matching Result Value

Throws:

DoesNotExistException - resultScaleKey is not found

InvalidParameterException - invalid resultScaleKey

MissingParameterException - null resultScaleKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValueKeysByType

@Transactional(readOnly=true)
public List<String> getResultValueKeysByType(String resultValueTypeKey,
                                                                   ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of result values by type.

Specified by:

getResultValueKeysByType in interface LRCService

Parameters:

resultValueTypeKey - identifier for the result group type

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

Returns:

list of result group identifiers

Throws:

DoesNotExistException - resultValueTypeKey not found

InvalidParameterException - invalid resultValueTypeKey

MissingParameterException - missing resultValueTypeKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesByKeys

@Transactional(readOnly=true)
public List<ResultValueInfo> getResultValuesByKeys(List<String> keys,
                                                                         ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of result value objects for a list of identifiers.

Specified by:

getResultValuesByKeys in interface LRCService

Parameters:

keys - identifier for the result

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

Returns:

list of result group identifiers

Throws:

DoesNotExistException - a resultValueKey from the list is not found

InvalidParameterException - invalid resultValueKeys

MissingParameterException - missing resultValueKeys

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesForResultValuesGroup

@Transactional(readOnly=true)
public List<ResultValueInfo> getResultValuesForResultValuesGroup(String resultValuesGroupKey,
                                                                                       ContextInfo contextInfo)
                                                          throws DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of result value objects for a specified result values group. It is sorted by the scale inside the values group.

Specified by:

getResultValuesForResultValuesGroup in interface LRCService

Parameters:

resultValuesGroupKey - identifier for the result values group

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

Returns:

list of result group identifiers

Throws:

DoesNotExistException - resultValueKey not found

InvalidParameterException - invalid resultValuesGroupKey

MissingParameterException - missing resultValuesGroupKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesForResultValuesGroups

@Transactional(readOnly=true)
public List<ResultValueInfo> getResultValuesForResultValuesGroups(List<String> resultValuesGroupKeys,
                                                                                        ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Description copied from interface: LRCService

Retrieves result values for the list of Result values groups. No values are selected for groups that are RANGES.

Specified by:

getResultValuesForResultValuesGroups in interface LRCService

Parameters:

resultValuesGroupKeys - list of result value groups for which to return values

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

Returns:

a list of unique result values for that set of groups

Throws:

DoesNotExistException - resultScaleKey is not found

InvalidParameterException - invalid resultScaleKey

MissingParameterException - null resultScaleKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesForScale

@Transactional(readOnly=true)
public List<ResultValueInfo> getResultValuesForScale(String resultScaleKey,
                                                                           ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Description copied from interface: LRCService

Retrieves result values by result scale key.

Specified by:

getResultValuesForScale in interface LRCService

Parameters:

resultScaleKey - key to the scale

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

Returns:

a list of result values for the scale

Throws:

DoesNotExistException - resultScaleKey is not found

InvalidParameterException - invalid resultScaleKey

MissingParameterException - null resultScaleKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroup

@Transactional(readOnly=true)
public ResultValuesGroupInfo getResultValuesGroup(String key,
                                                                        ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: LRCService

Retrieves existing result values group by an identifier.

Specified by:

getResultValuesGroup in interface LRCService

Parameters:

key - identifiers for resultValuesGroup to be retrieved

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

Returns:

details of the results for these Ids

Throws:

DoesNotExistException - resultValuesGroupKey not found

InvalidParameterException - invalid resultValuesGroupKey

MissingParameterException - invalid resultValuesGroupKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroupKeysByType

@Transactional(readOnly=true)
public List<String> getResultValuesGroupKeysByType(String resultValuesGroupTypeKey,
                                                                         ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of result group identifiers for a specified result values group type.

Specified by:

getResultValuesGroupKeysByType in interface LRCService

Parameters:

resultValuesGroupTypeKey - identifier for the result group type

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

Returns:

list of result group identifiers

Throws:

DoesNotExistException - resultValuesGroupTypeKey not found

InvalidParameterException - invalid resultValuesGroupTypeKey

MissingParameterException - missing resultValuesGroupTypeKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroupsByKeys

@Transactional(readOnly=true)
public List<ResultValuesGroupInfo> getResultValuesGroupsByKeys(List<String> keys,
                                                                                     ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Description copied from interface: LRCService

Retrieves result values groups by a list of identifiers.

Specified by:

getResultValuesGroupsByKeys in interface LRCService

Parameters:

keys - identifiers for result values group

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

Returns:

result values group list

Throws:

DoesNotExistException - resultValuesGroup not found

InvalidParameterException - invalid resultValuesGroupKeys

MissingParameterException - invalid resultValuesGroupKeys

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroupsByResultScale

@Transactional(readOnly=true)
public List<ResultValuesGroupInfo> getResultValuesGroupsByResultScale(String resultScaleKey,
                                                                                            ContextInfo contextInfo)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of existing result values groups that a result scale is tied to.

Specified by:

getResultValuesGroupsByResultScale in interface LRCService

Parameters:

resultScaleKey - identifier for result scale

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

Returns:

details of the results for these keys

Throws:

DoesNotExistException - resultValue not found

InvalidParameterException - invalid resultValueKey

MissingParameterException - invalid resultValueKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroupsByResultScaleType

@Transactional(readOnly=true)
public List<ResultValuesGroupInfo> getResultValuesGroupsByResultScaleType(String resultScaleTypeKey,
                                                                                                ContextInfo contextInfo)
                                                                   throws DoesNotExistException,
                                                                          InvalidParameterException,
                                                                          MissingParameterException,
                                                                          OperationFailedException,
                                                                          PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of existing result values groups that have a scale of the specified type.

Specified by:

getResultValuesGroupsByResultScaleType in interface LRCService

Parameters:

resultScaleTypeKey - identifier for result scale type key

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

Returns:

details of the results for these keys

Throws:

DoesNotExistException - resultValue not found

InvalidParameterException - invalid resultValueKey

MissingParameterException - invalid resultValueKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getResultValuesGroupsByResultValue

@Transactional(readOnly=true)
public List<ResultValuesGroupInfo> getResultValuesGroupsByResultValue(String resultValueKey,
                                                                                            ContextInfo contextInfo)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Description copied from interface: LRCService

Retrieves a list of existing result values groups that a result value is tied to.

Specified by:

getResultValuesGroupsByResultValue in interface LRCService

Parameters:

resultValueKey - identifier for result value

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

Returns:

details of the results for these keys

Throws:

DoesNotExistException - resultValue not found

InvalidParameterException - invalid resultValueKey

MissingParameterException - invalid resultValueKey

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateResultScale

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultScaleInfo updateResultScale(String key,
                                                                                                                                           ResultScaleInfo info,
                                                                                                                                           ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         VersionMismatchException

Description copied from interface: LRCService

Updates an existing result scale.

Specified by:

updateResultScale in interface LRCService

Parameters:

key - identifier of the result scale to update

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

Returns:

updated result scale information

Throws:

DataValidationErrorException - one or more values invalid for this operation

DoesNotExistException - resultScaleKey not found

MissingParameterException - missing resultScaleKey or resultScaleInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version

InvalidParameterException

updateResultValue

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValueInfo updateResultValue(String key,
                                                                                                                                           ResultValueInfo info,
                                                                                                                                           ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         VersionMismatchException

Description copied from interface: LRCService

Update a result value

Specified by:

updateResultValue in interface LRCService

Parameters:

key - resultValueKey to be updated

info - update information for the result value

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

Returns:

updated information about the result value

Throws:

DataValidationErrorException - one or more values invalid for this operation

DoesNotExistException - resultValueKey does not exist

InvalidParameterException - invalid resultValueKey, resultValueInfo

MissingParameterException - missing resultValueKey, resultValueInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version

updateResultValuesGroup

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public ResultValuesGroupInfo updateResultValuesGroup(String key,
                                                                                                                                                       ResultValuesGroupInfo info,
                                                                                                                                                       ContextInfo contextInfo)
                                              throws DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     VersionMismatchException

Description copied from interface: LRCService

Updates an existing result values group.

Specified by:

updateResultValuesGroup in interface LRCService

Parameters:

key - identifier of the result values group to update

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

Returns:

updated result values group information

Throws:

DataValidationErrorException - one or more values invalid for this operation

DoesNotExistException - resultValuesGroupKey not found

MissingParameterException - missing resultValuesGroupKey or resultValuesGroupInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version

InvalidParameterException

validateResultScale

public List<ValidationResultInfo> validateResultScale(String validationType,
                                                      ResultScaleInfo gradeScaleInfo,
                                                      ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Description copied from interface: LRCService

Validates a result scale. 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.

Specified by:

validateResultScale in interface LRCService

Parameters:

validationType - Identifier of the extent of validation

gradeScaleInfo - Result scale to be validated

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

Returns:

Throws:

DoesNotExistException - resultScaleInfo does not exist

InvalidParameterException - validationType or resultScaleInfo does not exist

MissingParameterException - missing validationType, resultScaleInfo

OperationFailedException - unable to complete request

validateResultValue

public List<ValidationResultInfo> validateResultValue(String validationType,
                                                      ResultValueInfo resultValueInfo,
                                                      ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Description copied from interface: LRCService

Validates a Result Value. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If 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. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Specified by:

validateResultValue in interface LRCService

Parameters:

validationType - Identifier of the extent of validation

resultValueInfo - Result value to be validated

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

Returns:

a ValidationResultInfo

Throws:

DoesNotExistException - resultValueInfo does not exist

InvalidParameterException - validationType or resultValueInfo does not exist

MissingParameterException - missing validationType or resultValueInfo

OperationFailedException - unable to complete request

validateResultValuesGroup

public List<ValidationResultInfo> validateResultValuesGroup(String validationType,
                                                            ResultValuesGroupInfo gradeValuesGroupInfo,
                                                            ContextInfo contextInfo)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException

Description copied from interface: LRCService

Validates a result values group. 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.

Specified by:

validateResultValuesGroup in interface LRCService

Parameters:

validationType - Identifier of the extent of validation

gradeValuesGroupInfo - Result values group to be validated

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

Returns:

Throws:

DoesNotExistException - resultValuesGroupInfo does not exist

InvalidParameterException - validationType or resultValuesGroupInfo does not exist

MissingParameterException - missing validationType, resultValuesGroupInfo

OperationFailedException - unable to complete request

getSearchTypes

public List<TypeInfo> getSearchTypes(ContextInfo contextInfo)
                              throws OperationFailedException,
                                     InvalidParameterException,
                                     MissingParameterException

Description copied from interface: SearchService

Retrieves the list of search types known by this service.

Specified by:

getSearchTypes in interface SearchService

Parameters:

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

Returns:

list of search type information

Throws:

OperationFailedException - unable to complete request

InvalidParameterException - contextInfo is not valid

MissingParameterException - contextInfo is missing or null

getSearchType

public TypeInfo getSearchType(String searchTypeKey,
                              ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException

Description copied from interface: SearchService

Retrieves information about a particular search type.

Specified by:

getSearchType in interface SearchService

Parameters:

searchTypeKey - identifier of the search type

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

Returns:

information on the search type

Throws:

DoesNotExistException - specified searchTypeKey not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - searchTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

search

public SearchResultInfo search(SearchRequestInfo searchRequest,
                               ContextInfo contextInfo)
                        throws MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               InvalidParameterException

Description copied from interface: SearchService

Performs a search.

Specified by:

search in interface SearchService

Parameters:

searchRequest - the search request

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

Returns:

the results of the search

Throws:

MissingParameterException - searchRequestInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

InvalidParameterException - contextInfo is not valid

searchForResultScaleIds

@Transactional(readOnly=true)
public List<String> searchForResultScaleIds(QueryByCriteria criteria,
                                                                  ContextInfo context)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: LRCService

Searches for result scale ids using a free form search criteria.

Specified by:

searchForResultScaleIds in interface LRCService

Returns:

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForResultScales

@Transactional(readOnly=true)
public List<ResultScaleInfo> searchForResultScales(QueryByCriteria criteria,
                                                                         ContextInfo context)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LRCService

Searches for result scales using a free form search criteria

Specified by:

searchForResultScales in interface LRCService

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForResultValueIds

@Transactional(readOnly=true)
public List<String> searchForResultValueIds(QueryByCriteria criteria,
                                                                  ContextInfo context)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: LRCService

Searches for result value ids using a free form search criteria.

Specified by:

searchForResultValueIds in interface LRCService

Returns:

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForResultValues

@Transactional(readOnly=true)
public List<ResultValueInfo> searchForResultValues(QueryByCriteria criteria,
                                                                         ContextInfo context)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LRCService

Searches for result values using a free form search criteria

Specified by:

searchForResultValues in interface LRCService

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForResultValuesGroupIds

@Transactional(readOnly=true)
public List<String> searchForResultValuesGroupIds(QueryByCriteria criteria,
                                                                        ContextInfo context)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: LRCService

Searches for result value group ids using a free form search criteria.

Specified by:

searchForResultValuesGroupIds in interface LRCService

Returns:

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForResultValuesGroups

@Transactional(readOnly=true)
public List<ResultValuesGroupInfo> searchForResultValuesGroups(QueryByCriteria criteria,
                                                                                     ContextInfo context)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Description copied from interface: LRCService

Searches for result value groups using a free form search criteria

Specified by:

searchForResultValuesGroups in interface LRCService

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException