SAM-3115 Tags and search in Samigo (sakaiproject#4090)

vaibhav-s · Mar 26, 2017 · 809632b · 809632b
1 parent ed54555
commit 809632b
Show file tree

Hide file tree

Showing 184 changed files with 11,985 additions and 599 deletions.
diff --git a/.../configuration/bundles/src/bundle/org/sakaiproject/config/bundle/default.sakai.properties b/.../configuration/bundles/src/bundle/org/sakaiproject/config/bundle/default.sakai.properties
@@ -4767,3 +4767,35 @@
 
 # The email address that will receive the confirmation mails from the import jobs (by default uses the defined in portal.error.email)
 #[email protected]
+
+#SAMIGO
+
+
+#show the search question option in the question creation page (default is false)
+#This needs elasticsearch service working
+#samigo.question.show.showSearchQuestion=false
+
+#Limit the max number of search results to appear in the search question (50 by default)
+#samigo.search.maxResults=50
+
+
+#Allow the use of tags in samigo in the authoring part(default is false)
+#samigo.author.usetags=false
+
+#Allows the instructors to delete tags from a question. (default is true)
+#samigo.author.allowDeleteTags=false
+
+#Allow the display of tags in the grading part (default is false)
+#samigo.evaluation.usetags=false
+
+
+#MULTI-TAGS PROPERTIES
+#If true, the tags will be updated in all the questions identical to the one edited (same hash). (default is false)
+#If this is enabled, it has preference over the value in samigo.author.multitag.singlequestion.check, so no check will appear to the user and the tags will be updated in any case. (Note: The admin user will always view the check)
+#samigo.author.multitag.singlequestion=false
+
+#If true, the tags will be updated in all the questions identical to the one edited (same hash) based on a check in the interface. (default is false)
+#If samigo.author.multitag.singlequestion is true it has preference over this one, so the check won't appear to the user and the saving in all the same hash questions will happen always.
+#If both samigo.author.multitag.singlequestion and samigo.author.multitag.singlequestion.check are false,
+# the tags will be independent in every question and saving one question won’t affect any other question.
+#samigo.author.multitag.singlequestion.check=false
diff --git a/library/pom.xml b/library/pom.xml
@@ -159,7 +159,15 @@
 			<version>2.3.2</version>
 			<scope>runtime</scope>
 		</dependency>
-	</dependencies>
+        <!-- https://mvnrepository.com/artifact/org.webjars/select2 -->
+        <dependency>
+            <groupId>org.webjars</groupId>
+            <artifactId>select2</artifactId>
+            <version>4.0.3</version>
+            <scope>runtime</scope>
+        </dependency>
+
+    </dependencies>
 	<profiles>
 		<profile>
 			<id>with-jsmath</id>

diff --git a/...samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemDataIfc.java b/...samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemDataIfc.java
@@ -24,6 +24,7 @@
 package org.sakaiproject.tool.assessment.data.ifc.assessment;
 
 import java.util.Date;
+import java.util.Map;
 import java.util.Set;
 import java.util.List;
 
@@ -129,10 +130,18 @@ public interface ItemDataIfc extends Comparable<ItemDataIfc>, java.io.Serializab
 
   void setItemMetaDataSet(Set<ItemMetaDataIfc> itemMetaDataSet);
 
+  Set<ItemTagIfc> getItemTagSet();
+
+  void setItemTagSet(Set<ItemTagIfc> itemTagSet);
+
   Set<ItemFeedbackIfc> getItemFeedbackSet();
 
   void setItemFeedbackSet(Set<ItemFeedbackIfc> itemFeedbackSet);
 
+  String getHash();
+
+  void setHash(String hash);
+
   String getItemMetaDataByLabel(String label);
 
   void addItemMetaData(String label, String entry);
@@ -174,6 +183,10 @@ public interface ItemDataIfc extends Comparable<ItemDataIfc>, java.io.Serializab
   void setItemAttachmentSet(Set<ItemAttachmentIfc> itemAttachmentSet);
 
   List<ItemAttachmentIfc> getItemAttachmentList();
+  void addItemAttachment(ItemAttachmentIfc attachment);
+  void removeItemAttachmentById(Long attachmentId);
+  void removeItemAttachment(ItemAttachmentIfc attachment);
+  Map<Long, ItemAttachmentIfc> getItemAttachmentMap();
 
   String getLeadInText();
   String getThemeText();
@@ -202,4 +215,6 @@ public interface ItemDataIfc extends Comparable<ItemDataIfc>, java.io.Serializab
   String getImageMapSrc();
   Boolean getScoreDisplayFlag();
   void setScoreDisplayFlag(Boolean scoreDisplayFlag);
+  public String getTagListToJsonString();
+  public void setTagListToJsonString(String tagListToJsonString);
 }
diff --git a/.../samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemTagIfc.java b/.../samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemTagIfc.java
@@ -0,0 +1,52 @@
+/**********************************************************************************
+ * $URL$
+ * $Id$
+ ***********************************************************************************
+ *
+ * Copyright (c) 2004, 2005, 2006, 2008 The Sakai Foundation
+ *
+ * Licensed under the Educational Community License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.opensource.org/licenses/ECL-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ **********************************************************************************/
+
+package org.sakaiproject.tool.assessment.data.ifc.assessment;
+
+import java.io.Serializable;
+
+public interface ItemTagIfc extends Serializable {
+
+    Long getId();
+
+    void setId(Long id);
+
+    ItemDataIfc getItem();
+
+    void setItem(ItemDataIfc item);
+
+    String getTagId();
+
+    void setTagId(String tagId);
+
+    String getTagLabel();
+
+    void setTagLabel(String tagLabel);
+
+    String getTagCollectionId();
+
+    void setTagCollectionId(String tagCollectionId);
+
+    String getTagCollectionName();
+
+    void setTagCollectionName(String tagCollectionName);
+
+}
diff --git a/...samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemTextIfc.java b/...samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/assessment/ItemTextIfc.java
@@ -25,6 +25,7 @@
 
 import java.util.List;
 import java.util.Set;
+import java.util.Map;
 
 public interface ItemTextIfc
     extends Comparable<ItemTextIfc>, java.io.Serializable
@@ -68,6 +69,14 @@ public interface ItemTextIfc
      * @return
      * @since 2.10
      */
+
+  void addItemTextAttachment(ItemTextAttachmentIfc attachment);
+  void addNewItemTextAttachment(ItemTextAttachmentIfc attachment);
+  void removeItemTextAttachmentById(Long attachmentId);
+  void removeItemTextAttachment(ItemTextAttachmentIfc attachment);
+  Map<Long, ItemTextAttachmentIfc> getItemTextAttachmentMap();
+
+
     public boolean isEmiQuestionItemText();
 
     /**

diff --git a/...o/samigo-api/src/java/org/sakaiproject/tool/assessment/entity/api/ItemEntityProvider.java b/...o/samigo-api/src/java/org/sakaiproject/tool/assessment/entity/api/ItemEntityProvider.java
@@ -0,0 +1,15 @@
+package org.sakaiproject.tool.assessment.entity.api;
+
+import org.sakaiproject.entitybroker.entityprovider.EntityProvider;
+
+/**
+ * Entity Provider for samigo Item
+ *
+ * @author Unicon
+ *
+ */
+public interface ItemEntityProvider extends EntityProvider {
+
+    public final static String ENTITY_PREFIX = "sam_item";
+
+}
diff --git a/...api/src/java/org/sakaiproject/tool/assessment/entity/api/PublishedItemEntityProvider.java b/...api/src/java/org/sakaiproject/tool/assessment/entity/api/PublishedItemEntityProvider.java
@@ -0,0 +1,15 @@
+package org.sakaiproject.tool.assessment.entity.api;
+
+import org.sakaiproject.entitybroker.entityprovider.EntityProvider;
+
+/**
+ * Entity Provider for samigo Item
+ *
+ * @author Unicon
+ *
+ */
+public interface PublishedItemEntityProvider extends EntityProvider {
+
+    public final static String ENTITY_PREFIX = "sam_publisheditem";
+
+}
diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/audioRecordingTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/audioRecordingTemplate.xml
@@ -22,6 +22,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>
@@ -77,4 +81,4 @@
       </material>
     </flow_mat>
   </itemfeedback>
-</item>
+</item>
diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/calculatedQuestionTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/calculatedQuestionTemplate.xml
@@ -24,6 +24,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/emiTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/emiTemplate.xml
@@ -26,6 +26,10 @@
 				<fieldlabel>ITEM_RUBRIC</fieldlabel>
 				<fieldentry />
 			</qtimetadatafield>
+			<qtimetadatafield>
+				<fieldlabel>ITEM_TAGS</fieldlabel>
+				<fieldentry/>
+			</qtimetadatafield>
 			<qtimetadatafield>
 				<fieldlabel>ATTACHMENT</fieldlabel>
 				<fieldentry />

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/essayTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/essayTemplate.xml
@@ -23,6 +23,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/fibTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/fibTemplate.xml
@@ -33,6 +33,10 @@
       <qtimetadatafield>
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
+      </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
       </qtimetadatafield>
 	  <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/fileUploadTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/fileUploadTemplate.xml
@@ -22,6 +22,10 @@
           <fieldlabel>ITEM_RUBRIC</fieldlabel>
           <fieldentry/>
         </qtimetadatafield>
+        <qtimetadatafield>
+          <fieldlabel>ITEM_TAGS</fieldlabel>
+          <fieldentry/>
+        </qtimetadatafield>
         <qtimetadatafield>
           <fieldlabel>ATTACHMENT</fieldlabel>
           <fieldentry/>
@@ -71,4 +75,4 @@
         </material>
       </flow_mat>
     </itemfeedback>
-</item>
+</item>
diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/finTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/finTemplate.xml
@@ -22,6 +22,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/matchTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/matchTemplate.xml
@@ -24,6 +24,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/mcMCSSTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/mcMCSSTemplate.xml
@@ -27,6 +27,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/mcMCTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/mcMCTemplate.xml
@@ -27,6 +27,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/mcSCTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/mcSCTemplate.xml
@@ -26,6 +26,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/mcSurveyTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/mcSurveyTemplate.xml
@@ -27,6 +27,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+	 <qtimetadatafield>
+		<fieldlabel>ITEM_TAGS</fieldlabel>
+		<fieldentry/>
+	  </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>
@@ -53,4 +57,4 @@
 			</material>			 
 		</flow_mat>
 	</itemfeedback>
-</item> 
+</item>
diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/mxSurveyTemplate.xml b/samigo/samigo-api/src/java/xml/author/v1p2/mxSurveyTemplate.xml
@@ -24,6 +24,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/survey/10.xml b/samigo/samigo-api/src/java/xml/author/v1p2/survey/10.xml
@@ -27,6 +27,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>

diff --git a/samigo/samigo-api/src/java/xml/author/v1p2/survey/5.xml b/samigo/samigo-api/src/java/xml/author/v1p2/survey/5.xml
@@ -27,6 +27,10 @@
         <fieldlabel>ITEM_RUBRIC</fieldlabel>
         <fieldentry/>
       </qtimetadatafield>
+      <qtimetadatafield>
+        <fieldlabel>ITEM_TAGS</fieldlabel>
+        <fieldentry/>
+      </qtimetadatafield>
       <qtimetadatafield>
         <fieldlabel>ATTACHMENT</fieldlabel>
         <fieldentry/>