From b1affe92460637211f560d70ee5c8770f3952822 Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <ahopk127@my.yorku.ca>
Date: Sun, 10 Apr 2022 14:22:29 -0500
Subject: Created API for settings and unit/prefix viewing

---
 src/main/java/sevenUnitsGUI/View.java | 56 +++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

(limited to 'src/main/java/sevenUnitsGUI/View.java')

diff --git a/src/main/java/sevenUnitsGUI/View.java b/src/main/java/sevenUnitsGUI/View.java
index e78c9cc..da3749e 100644
--- a/src/main/java/sevenUnitsGUI/View.java
+++ b/src/main/java/sevenUnitsGUI/View.java
@@ -16,6 +16,12 @@
  */
 package sevenUnitsGUI;
 
+import java.util.Optional;
+import java.util.Set;
+
+import sevenUnits.unit.UnitType;
+import sevenUnits.utils.NameSymbol;
+
 /**
  * An object that controls user interaction with 7Units
  * 
@@ -23,6 +29,35 @@ package sevenUnitsGUI;
  * @since 2021-12-15
  */
 public interface View {
+	/**
+	 * @return name of prefix currently being viewed
+	 * @since 2022-04-10
+	 */
+	Optional<String> getViewedPrefixName();
+	
+	/**
+	 * @return name of unit currently being viewed
+	 * @since 2022-04-10
+	 */
+	Optional<String> getViewedUnitName();
+	
+	/**
+	 * Sets the list of prefixes that are available to be viewed in a prefix
+	 * viewer
+	 *
+	 * @param prefixNames prefix names to view
+	 * @since 2022-04-10
+	 */
+	void setViewablePrefixNames(Set<String> prefixNames);
+	
+	/**
+	 * Sets the list of units that are available to be viewed in a unit viewer
+	 *
+	 * @param unitNames unit names to view
+	 * @since 2022-04-10
+	 */
+	void setViewableUnitNames(Set<String> unitNames);
+	
 	/**
 	 * Shows an error message.
 	 *
@@ -32,4 +67,25 @@ public interface View {
 	 * @since 2021-12-15
 	 */
 	void showErrorMessage(String title, String message);
+	
+	/**
+	 * Shows information about a prefix to the user.
+	 *
+	 * @param name             name(s) and symbol of prefix
+	 * @param multiplierString string representation of prefix multiplier
+	 * @since 2022-04-10
+	 */
+	void showPrefix(NameSymbol name, String multiplierString);
+	
+	/**
+	 * Shows information about a unit to the user.
+	 *
+	 * @param name          name(s) and symbol of unit
+	 * @param definition    unit's definition string
+	 * @param dimensionName name of unit's dimension
+	 * @param type          type of unit (metric/semi-metric/non-metric)
+	 * @since 2022-04-10
+	 */
+	void showUnit(NameSymbol name, String definition, String dimensionName,
+			UnitType type);
 }
-- 
cgit v1.2.3