RT-2260 Created OutcomeObject class (#458)

* Created OutcomeObject class

* Changed capitalization of severity enum values and removed fatal

Author: boxwala

.gitignore

@@ -8,3 +8,4 @@ target/
 .recommenders
 .idea/
 .factorypath
+generic-model/.vscode/settings.json

generic-model/pom.xml

@@ -23,6 +23,14 @@
 		<version>0.0.9-SNAPSHOT</version>
 	</parent>
 	<artifactId>generic-model</artifactId>
+	<version>0.1.0</version>
 	<name>Base model for the Generic services</name>
 	<description>Representation of ServiceRequest and ServiceResponse</description>
+	<dependencies>
+		<dependency>
+			<groupId>junit</groupId>
+			<artifactId>junit</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
 </project>

generic-model/src/main/java/io/elimu/a2d2/genericmodel/Issue.java

@@ -0,0 +1,62 @@
+package io.elimu.a2d2.genericmodel;
+
+public class Issue implements java.io.Serializable{
+
+    private static final long serialVersionUID = 1L;
+
+    public enum IssueSeverity {
+        INFORMATION,
+        WARNING,
+        ERROR
+    }
+
+    public enum IssueType {
+        INVALID_VALUE,
+        INVALID_STRUCTURE,
+        MISSING_ITEM,
+        SECURITY_EXPIRED,
+        SECURITY_FORBIDDEN,
+        PROCESSING_NOT_SUPPORTED,
+        PROCESSING_DUPLICATE,
+        PROCESSING_MULTIPLE_MATCHES,
+        PROCESSING_NOT_FOUND,
+        PROCESSING_BUSINESS_RULE_VIOLATION,
+        TRANSIENT_TIMEOUT,
+        TRANSIENT_EXCEPTION,
+        INFORMATIONAL
+    }
+    private IssueType code;
+
+
+    private IssueSeverity severity;
+    private String diagnostics;
+
+
+    public Issue() {
+    }
+
+    public IssueSeverity getSeverity() {
+        return severity;
+    }
+
+    public void setSeverity(IssueSeverity severity) {
+        this.severity = severity;
+    }
+
+    public IssueType getCode() {
+        return code;
+    }
+
+    public void setCode(IssueType code) {
+        this.code = code;
+    }
+
+    public String getDiagnostics() {
+        return diagnostics;
+    }
+
+    public void setDiagnostics(String diagnostics) {
+        this.diagnostics = diagnostics;
+    }
+
+}

generic-model/src/main/java/io/elimu/a2d2/genericmodel/OutcomeObject.java

@@ -0,0 +1,52 @@
+package io.elimu.a2d2.genericmodel;
+
+import java.util.ArrayList;
+import java.util.List;
+public class OutcomeObject implements java.io.Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private List<Issue> issues;
+
+    private void init() {
+        if (issues == null) {
+            issues = new ArrayList<>();
+        }
+    }
+
+    public OutcomeObject() {
+        init();
+    }
+
+    public List<Issue> getIssues() {
+        return issues;
+    }
+
+    public void setIssues(List<Issue> issues) {
+        this.issues = issues;
+    }
+
+    public void addIssue(Issue issue) {
+        this.issues.add(issue);
+    }
+
+    public void removeIssue(Issue issue) {
+        this.issues.remove(issue);
+    }
+
+    public void clearIssues() {
+        this.issues.clear();
+    }
+
+    public boolean hasErrors() {
+        if (issues == null) {
+            return false;
+        }
+        for (Issue issue : issues) {
+            if (issue != null && Issue.IssueSeverity.ERROR.equals(issue.getSeverity())) {
+                return true;
+            }
+        }
+        return false;
+    }
+}

generic-model/src/test/java/io/elimu/a2d2/genericmodel/IssueTest.java

@@ -0,0 +1,29 @@
+package io.elimu.a2d2.genericmodel;
+
+
+import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+
+public class IssueTest {
+
+    @Test
+    public void testSeverityGetterSetter() {
+        Issue issue = new Issue();
+        issue.setSeverity(Issue.IssueSeverity.ERROR);
+        assertEquals(Issue.IssueSeverity.ERROR, issue.getSeverity());
+    }
+
+    @Test
+    public void testCodeGetterSetter() {
+        Issue issue = new Issue();
+        issue.setCode(Issue.IssueType.INVALID_VALUE);
+        assertEquals(Issue.IssueType.INVALID_VALUE, issue.getCode());
+    }
+
+    @Test
+    public void testDiagnosticsGetterSetter() {
+        Issue issue = new Issue();
+        issue.setDiagnostics("Some diagnostics");
+        assertEquals("Some diagnostics", issue.getDiagnostics());
+    }
+}

generic-model/src/test/java/io/elimu/a2d2/genericmodel/OutcomeObjectTest.java

@@ -0,0 +1,68 @@
+package io.elimu.a2d2.genericmodel;
+
+import java.util.Arrays;
+import org.junit.Test;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertEquals;
+
+public class OutcomeObjectTest {
+
+    @Test
+    public void testAddAndGetIssues() {
+        OutcomeObject outcome = new OutcomeObject();
+        Issue issue = new Issue();
+        issue.setSeverity(Issue.IssueSeverity.WARNING);
+        outcome.addIssue(issue);
+        assertEquals(1, outcome.getIssues().size());
+        assertEquals(Issue.IssueSeverity.WARNING, outcome.getIssues().get(0).getSeverity());
+    }
+
+    @Test
+    public void testSetIssues() {
+        OutcomeObject outcome = new OutcomeObject();
+        Issue issue1 = new Issue();
+        issue1.setSeverity(Issue.IssueSeverity.INFORMATION);
+        Issue issue2 = new Issue();
+        issue2.setSeverity(Issue.IssueSeverity.ERROR);
+        outcome.setIssues(Arrays.asList(issue1, issue2));
+        assertEquals(2, outcome.getIssues().size());
+    }
+
+    @Test
+    public void testRemoveIssue() {
+        OutcomeObject outcome = new OutcomeObject();
+        Issue issue = new Issue();
+        outcome.addIssue(issue);
+        outcome.removeIssue(issue);
+        assertTrue(outcome.getIssues().isEmpty());
+    }
+
+    @Test
+    public void testClearIssues() {
+        OutcomeObject outcome = new OutcomeObject();
+        outcome.addIssue(new Issue());
+        outcome.clearIssues();
+        assertTrue(outcome.getIssues().isEmpty());
+    }
+
+    @Test
+    public void testHasErrors() {
+        OutcomeObject outcome = new OutcomeObject();
+        Issue info = new Issue();
+        info.setSeverity(Issue.IssueSeverity.INFORMATION);
+        Issue error = new Issue();
+        error.setSeverity(Issue.IssueSeverity.ERROR);
+        outcome.addIssue(info);
+        assertFalse(outcome.hasErrors());
+        outcome.addIssue(error);
+        assertTrue(outcome.hasErrors());
+    }
+
+    @Test
+    public void testHasErrorsWithNullIssues() {
+        OutcomeObject outcome = new OutcomeObject();
+        outcome.setIssues(null);
+        assertFalse(outcome.hasErrors());
+    }
+}