Package ch.tocco.nice2.optional.qualification.impl.action

Interface EvaluationActionService

All Known Implementing Classes:

EvaluationActionServiceImpl

public interface EvaluationActionService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EvaluationActionService.ColumnModel
static class	EvaluationActionService.GridInfo	A grid of GridRecords to handle all promotion data about participants affected by an Evaluation
static class	EvaluationActionService.MetaData	Meta data class holding all information of an Evaluation result to be displayed to the user.

Method Summary

Modifier and Type	Method	Description
void	evaluate(EntityExplorerActionSelection selection)	Evaluates a selection of evaluations.
void	evaluateAndExport(EntityExplorerActionSelection selection, String language, String fileName, String evaluationExtensionName, boolean runInBackground)	Evaluates a selection of evaluations in the background.
EvaluationActionService.GridInfo	getGridInfo(EntityExplorerActionSelection selection)	Prepares and returns a grid with all promotion data of the participants affected by the provided Evaluation.
EvaluationTreeGridInfo	getLecturerTreeGridInfoByKey(String evaluationPk, boolean showPromotionStatus)	Behaves the same way as getTreeGridInfo(EntityExplorerActionSelection) but uses a pk as String instead of a EntityExplorerActionSelection and it always expects a Evaluation pk.
EvaluationActionService.GridInfo	getLocalizedGridInfo(Entity entity, Locale locale, @Nullable AdditionalFieldRecordConfig config)
EvaluationActionService.GridInfo	getLocalizedGridInfo(Entity entity, Locale locale, Set<String> uniquePksToIgnore, Set<String> recursivePksToIgnore, @Nullable AdditionalFieldRecordConfig config)
EvaluationActionService.MetaData	getMetaData(EntityExplorerActionSelection selection)	Collects and returns the meta data for a single given Evaluation entity to be displayed to the user.
EvaluationActionService.MetaData	getMetaDataByKey(String evaluationPk)	Behaves the same ways as getMetaData(EntityExplorerActionSelection) but it loads the Evaluation from a String pk instead of a EntityExplorerActionSelection.
EvaluationTreeGridInfo	getParticipantTreeGridInfoByKey(String evaluationPk, boolean showPromotionStatus)	Behaves the same way as getTreeGridInfo(EntityExplorerActionSelection) but uses a pk as String instead of a EntityExplorerActionSelection and it always expects a Evaluation pk.
EvaluationTreeGridInfo	getTreeGridInfo(EntityExplorerActionSelection selection)	Prepares and returns all data needed to build a TreeGrid in the UI with all promotion data of the participants affected by the provided Evaluation.

Method Details

evaluate

void evaluate(EntityExplorerActionSelection selection)
       throws InterruptedException

Evaluates a selection of evaluations. The passed selection can either consist of Evaluation entities or Evaluation_data entities being related to an Evaluation.

The result will be handled by the triggered tasks instead of being returned.

Parameters:

selection - the selection. Has to be of EntityModel Evaluation or Evaluation_data

Throws:

InterruptedException

See Also:

• EvaluationActionService.GridInfo
• GridRecord
• evaluate(EntityExplorerActionSelection)

getLocalizedGridInfo

EvaluationActionService.GridInfo getLocalizedGridInfo(Entity entity,
 Locale locale,
 @Nullable
 @Nullable AdditionalFieldRecordConfig config)
                                               throws InterruptedException

Throws:

InterruptedException

getGridInfo

EvaluationActionService.GridInfo getGridInfo(EntityExplorerActionSelection selection)
                                      throws InterruptedException,
NoEntityToLoadException

Prepares and returns a grid with all promotion data of the participants affected by the provided Evaluation. The passed selection can either consist of Evaluation entities or Evaluation_data entities being related to an Evaluation.

Parameters:

selection - the selection. Has to be of EntityModel Evaluation or Evaluation_data

Returns:

the grid containing the participant's promotion information

Throws:

InterruptedException

NoEntityToLoadException

See Also:

• EvaluationActionService.GridInfo
• GridRecord
• evaluate(EntityExplorerActionSelection)

getTreeGridInfo

EvaluationTreeGridInfo getTreeGridInfo(EntityExplorerActionSelection selection)
                                throws InterruptedException,
NoEntityToLoadException

Prepares and returns all data needed to build a TreeGrid in the UI with all promotion data of the participants affected by the provided Evaluation. The passed selection can either consist of Evaluation entities or Evaluation_data entities being related to an Evaluation.

Parameters:

selection - the selection. Has to be of EntityModel Evaluation or Evaluation_data

Returns:

the grid containing the participant's promotion information

Throws:

InterruptedException

NoEntityToLoadException

See Also:

• EvaluationTreeGridInfo
• EvaluationTreeGridInfo.CellDisplay
• evaluate(EntityExplorerActionSelection)

getParticipantTreeGridInfoByKey

EvaluationTreeGridInfo getParticipantTreeGridInfoByKey(String evaluationPk,
 boolean showPromotionStatus)
                                                throws NoEntityToLoadException,
InterruptedException

Behaves the same way as getTreeGridInfo(EntityExplorerActionSelection) but uses a pk as String instead of a EntityExplorerActionSelection and it always expects a Evaluation pk. Only the data of the current user is displayed and an additional column with the max points is added.

Parameters:

evaluationPk - the pk of the selected Evaluation

showPromotionStatus - configures whether the promotion status row should be included

Returns:

the grid containing the participant's promotion information

Throws:

NoEntityToLoadException

InterruptedException

getLecturerTreeGridInfoByKey

EvaluationTreeGridInfo getLecturerTreeGridInfoByKey(String evaluationPk,
 boolean showPromotionStatus)
                                             throws NoEntityToLoadException,
InterruptedException

Behaves the same way as getTreeGridInfo(EntityExplorerActionSelection) but uses a pk as String instead of a EntityExplorerActionSelection and it always expects a Evaluation pk. An additional column showing the max points is added.

Parameters:

evaluationPk - the pk of the selected Evaluation

showPromotionStatus - configures whether the promotion status row should be included

Returns:

the grid containing the participant's promotion information

Throws:

NoEntityToLoadException

InterruptedException

getLocalizedGridInfo

EvaluationActionService.GridInfo getLocalizedGridInfo(Entity entity,
 Locale locale,
 Set<String> uniquePksToIgnore,
 Set<String> recursivePksToIgnore,
 @Nullable
 @Nullable AdditionalFieldRecordConfig config)
                                               throws InterruptedException

Throws:

InterruptedException

getMetaData

EvaluationActionService.MetaData getMetaData(EntityExplorerActionSelection selection)

Collects and returns the meta data for a single given Evaluation entity to be displayed to the user.

Parameters:

selection - the selected Evaluation. Must not have more than one entry.

Returns:

the collected meta data

See Also:

• EvaluationActionService.MetaData
• evaluate(EntityExplorerActionSelection)

evaluateAndExport

void evaluateAndExport(EntityExplorerActionSelection selection,
 String language,
 String fileName,
 String evaluationExtensionName,
 boolean runInBackground)

Evaluates a selection of evaluations in the background. The passed selection can either consist of Evaluation entities or Evaluation_data entities being related to an Evaluation.

After the evaluation, the ExcelExportActionService is triggered, in the background as well. The default displays are used as filenames for the exports.

Parameters:

selection - the selection. Has to be of EntityModel Evaluation or Evaluation_data

See Also:

• evaluate(EntityExplorerActionSelection)

getMetaDataByKey

EvaluationActionService.MetaData getMetaDataByKey(String evaluationPk)

Behaves the same ways as getMetaData(EntityExplorerActionSelection) but it loads the Evaluation from a String pk instead of a EntityExplorerActionSelection.

Parameters:

evaluationPk - the pk of the selected Evaluation

Returns:

the collected meta data