Interface InputEditActionService

All Known Implementing Classes:

InputEditActionServiceImpl

public interface InputEditActionService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InputEditActionService.ChoiceRatingValue
static class	InputEditActionService.ExamEditorFormData
static class	InputEditActionService.FinishedResponse
static class	InputEditActionService.FormInfo
static class	InputEditActionService.MasterData
static class	InputEditActionService.ServerFeedback

Method Summary

Modifier and Type	Method	Description
@Nullable String	areInputsCompatibleForEdit(EntityExplorerActionSelection selection)	checks if a selection can be used together to input data, things compared are number of ratings active exams input nodes
InputEditActionService.FinishedResponse	finishInput(EntityExplorerActionSelection selectedInput)
List<AbstractInputType.ExamRecord>	getActiveExams(EntityExplorerActionSelection selectedInput)	Get all active Exams for the selected Input.
List<AbstractInputType.ExamRecord>	getExams(EntityExplorerActionSelection selection)	Returns all Exams related to the selected Input even if they are defined as inactive by their Exam.FIELD_NR exceeding the Input's numRatings value.
InputEditActionService.ExamEditorFormData	getExamsEditorFormData(EntityExplorerActionSelection selection)
List<AbstractInputType.ExamRecord>	getExamsWithLimit(EntityExplorerActionSelection selection, int limit)	Returns all Exams related to the selected Input not exceeding the given limit, even if they are defined as inactive by their Exam.FIELD_NR exceeding the Input's numRatings value.
InputEditActionService.FormInfo	getFormInfo(EntityExplorerActionSelection selection)
Collection<DataStoreRecord>	getInputData(EntityExplorerActionSelection inputSelection)
InputEditActionService.FormInfo	getLocalizedFormInfo(EntityExplorerActionSelection selectedInput, Locale locale)
Collection<DataStoreRecord>	getLocalizedInputData(Entity inputEntity, Locale locale)
InputEditActionService.MasterData	getMasterData(EntityExplorerActionSelection selection)
AbstractInputType.AbstractStatistics	getStatistics(EntityExplorerActionSelection selection)
boolean	isEvaluationAllowed(EntityExplorerActionSelection selection)	checks if any evaluation going upwards has been published.
void	triggerEvaluation(EntityExplorerActionSelection selection)	start the evaluation of an evaluation entity by running EvaluationTask on it
void	updateExams(EntityExplorerActionSelection selectedInput, AbstractInputType.ExamRecord[] examRecords)	Updates details of the Exams connected to the edited Input as well as the number of Exam / Ratings.
InputEditActionService.ServerFeedback	writeInboundRecord(EntityExplorerActionSelection selection, AbstractInputType.InboundInputDataRecord inboundInputDataRecord)
InputEditActionService.ServerFeedback	writeInboundRecord(EntityExplorerActionSelection selection, AbstractInputType.InboundRatingRecord inboundRatingRecord)

Method Details

areInputsCompatibleForEdit

@Nullable
@Nullable String areInputsCompatibleForEdit(EntityExplorerActionSelection selection)

checks if a selection can be used together to input data, things compared are

• number of ratings
• active exams
• input nodes

Parameters:

selection - the selection

Returns:

String the validation message, or null if valid

getFormInfo

InputEditActionService.FormInfo getFormInfo(EntityExplorerActionSelection selection)
                                     throws InterruptedException

Throws:

InterruptedException

getLocalizedFormInfo

InputEditActionService.FormInfo getLocalizedFormInfo(EntityExplorerActionSelection selectedInput,
 Locale locale)
                                              throws InterruptedException

Throws:

InterruptedException

getInputData

Collection<DataStoreRecord> getInputData(EntityExplorerActionSelection inputSelection)

getLocalizedInputData

Collection<DataStoreRecord> getLocalizedInputData(Entity inputEntity,
 Locale locale)

writeInboundRecord

InputEditActionService.ServerFeedback writeInboundRecord(EntityExplorerActionSelection selection,
 AbstractInputType.InboundInputDataRecord inboundInputDataRecord)
                                                  throws InterruptedException

Throws:

InterruptedException

writeInboundRecord

InputEditActionService.ServerFeedback writeInboundRecord(EntityExplorerActionSelection selection,
 AbstractInputType.InboundRatingRecord inboundRatingRecord)

getMasterData

InputEditActionService.MasterData getMasterData(EntityExplorerActionSelection selection)

getStatistics

AbstractInputType.AbstractStatistics getStatistics(EntityExplorerActionSelection selection)

getActiveExams

List<AbstractInputType.ExamRecord> getActiveExams(EntityExplorerActionSelection selectedInput)

Get all active Exams for the selected Input.

Parameters:

selectedInput - the edited Input

Returns:

a list of records containing the Exam's information

See Also:

• Input.getActiveExams()

getExams

List<AbstractInputType.ExamRecord> getExams(EntityExplorerActionSelection selection)

Returns all Exams related to the selected Input even if they are defined as inactive by their Exam.FIELD_NR exceeding the Input's numRatings value.

Parameters:

selection - the selected Input

Returns:

a list of records containing the Exam's information

getExamsWithLimit

List<AbstractInputType.ExamRecord> getExamsWithLimit(EntityExplorerActionSelection selection,
 int limit)

Returns all Exams related to the selected Input not exceeding the given limit, even if they are defined as inactive by their Exam.FIELD_NR exceeding the Input's numRatings value.

Parameters:

selection - the selected Input

limit - the limit of exams to get for the Input

Returns:

a list of records containing the Exam's information

See Also:

• Input.getActiveExams()

updateExams

void updateExams(EntityExplorerActionSelection selectedInput,
 AbstractInputType.ExamRecord[] examRecords)
          throws InterruptedException

Updates details of the Exams connected to the edited Input as well as the number of Exam / Ratings.

Parameters:

selectedInput - the edited Input

examRecords - the records holding the Exam's information

Throws:

InterruptedException

See Also:

• Input.getExams(int)
• Input.getActiveExams()

finishInput

InputEditActionService.FinishedResponse finishInput(EntityExplorerActionSelection selectedInput)
                                             throws InterruptedException

Throws:

InterruptedException

getExamsEditorFormData

InputEditActionService.ExamEditorFormData getExamsEditorFormData(EntityExplorerActionSelection selection)

isEvaluationAllowed

boolean isEvaluationAllowed(EntityExplorerActionSelection selection)

checks if any evaluation going upwards has been published. only published evaluations are allowed to be evaluated

Parameters:

selection - the selected entity

Returns:

true if the evaluation should be allowed, meaning the button will be shown, false otherwise

triggerEvaluation

void triggerEvaluation(EntityExplorerActionSelection selection)

start the evaluation of an evaluation entity by running EvaluationTask on it

Parameters:

selection - the selected entity