edu.kit.kastel.sdq.artemis4j.api.grading.IRatingGroup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis4j Show documentation

Artemis4J is a Java library for interacting with the Artemis teaching system.

There is a newer version: 7.5.6

/* Licensed under EPL-2.0 2022-2023. */
package edu.kit.kastel.sdq.artemis4j.api.grading;

import edu.kit.kastel.sdq.artemis4j.util.Pair;

import java.util.List;

/**
 * {@link IMistakeType}s belong to a {@link IRatingGroup}. Rating Groups may
 * introduce penalty limits for calculation, capping the maximum penalty that
 * all {@link IMistakeType}s belonging to one {@link IRatingGroup} can reach in
 * sum.
 */
public interface IRatingGroup {
	String getIdentifier();

	/**
	 * Get the display name of the rating group.
	 *
	 * @param languageKey the key of the language that is selected. (e.g., "de").
	 *                    Can be null to use the default language.
	 * @return the human-readable name of the rating group.
	 */
	String getDisplayName(String languageKey);

	/**
	 * @return the MistakeTypes that define this RatingGroup as its rating group.
	 */
	List getMistakeTypes();

	/**
	 * @return the minimum or maximum penalty that all {@link IMistakeType}
	 *         belonging to one {@link IRatingGroup} can reach in sum
	 */
	double setToRange(double points);

	/**
	 * @return [negative_limit, positive_limit]
	 */
	Pair getRange();

}