OPSMN-3953: CP level setting to specify whether to collect only

primary specimens or all specimens on completion of visit.
Related UI and API changes. (2/4)

OPSMN-3856: Set the institute in the input filters objects.
This makes the load users function very flexible to reuse.

Author: vinayakapawar

WEB-INF/resources/com/krishagni/catissueplus/core/repository/hbm/CollectionProtocol.hbm.xml

@@ -69,6 +69,14 @@
 
     <property name="aliquotsInSameContainer" column="ALIQUOTS_IN_SAME_CONT"/>
 
+    <property name="visitCollectionMode" column="VISIT_COLLECTION_MODE">
+      <type name="org.hibernate.type.EnumType">
+        <param name="enumClass">
+          com.krishagni.catissueplus.core.biospecimen.domain.CollectionProtocol$VisitCollectionMode
+        </param>
+      </type>
+    </property>
+
     <property name="visitNamePrintMode" column="VISIT_NAME_PRINT_MODE">
       <type name="org.hibernate.type.EnumType">
         <param name="enumClass">

WEB-INF/resources/db/4.2/audit.xml

@@ -44,4 +44,11 @@
       <column name="specimenList_MOD" type="${bit.type}"/>
     </addColumn>
   </changeSet>
+
+  <changeSet author="vpawar" id="Track visit collection mode setting changes">
+    <addColumn tableName="CAT_COLLECTION_PROTOCOL_AUD">
+      <column name="VISIT_COLLECTION_MODE" type="${text.type}(16)"/>
+      <column name="visitCollectionMode_MOD" type="${bit.type}"/>
+    </addColumn>
+  </changeSet>
 </databaseChangeLog>

WEB-INF/resources/db/4.2/schema.xml

@@ -153,4 +153,10 @@
       <column name="STATE" type="${tinyint.type}"/>
     </addColumn>
   </changeSet>
+
+  <changeSet author="vpawar" id="Collection protocol setting to specify visit collection mode">
+    <addColumn tableName="CATISSUE_COLLECTION_PROTOCOL">
+      <column name="VISIT_COLLECTION_MODE" type="${text.type}(16)"/>
+    </addColumn>
+  </changeSet>
 </databaseChangeLog>

WEB-INF/resources/errors/messages.properties

@@ -864,6 +864,8 @@ cp_sop_doc_moved_or_deleted=SOP document {1} for collection protocol {0} is eith
 
 cp_invalid_sop_doc=Invalid SOP document file handle {0}.
 
+cp_invalid_visit_coll_mode=Invalid visit collection mode: {0}.
+
 cp_invalid_visit_name_print_mode=Invalid visit print mode: {0}.
 
 cp_invalid_spmn_label_pre_print_mode=Invalid specimen label pre-print mode: {0}.

WEB-INF/src/com/krishagni/catissueplus/core/biospecimen/domain/CollectionProtocol.java

@@ -34,20 +34,25 @@ public class CollectionProtocol extends BaseExtensionEntity {
 	public enum SpecimenLabelPrePrintMode {
 		ON_REGISTRATION,
 		ON_VISIT,
-		NONE;
+		NONE
 	}
 
 	public enum SpecimenLabelAutoPrintMode {
 		PRE_PRINT,
 		ON_COLLECTION,
-		NONE;
+		NONE
 	}
 
 
 	public enum VisitNamePrintMode {
 		PRE_PRINT,
 		ON_COMPLETION,
-		NONE;
+		NONE
+	}
+
+	public enum VisitCollectionMode {
+		PRIMARY_SPMNS,
+		ALL_SPMNS
 	}
 
 	public static final String EXTN = "CollectionProtocolExtension";
@@ -112,6 +117,8 @@ public enum VisitNamePrintMode {
 
 	private Boolean aliquotsInSameContainer;
 
+	private VisitCollectionMode visitCollectionMode = VisitCollectionMode.ALL_SPMNS;
+
 	private VisitNamePrintMode visitNamePrintMode = VisitNamePrintMode.NONE;
 
 	private Integer visitNamePrintCopies;
@@ -361,6 +368,14 @@ public void setAliquotsInSameContainer(Boolean aliquotsInSameContainer) {
 		this.aliquotsInSameContainer = aliquotsInSameContainer;
 	}
 
+	public VisitCollectionMode getVisitCollectionMode() {
+		return visitCollectionMode == null ? VisitCollectionMode.ALL_SPMNS : visitCollectionMode;
+	}
+
+	public void setVisitCollectionMode(VisitCollectionMode visitCollectionMode) {
+		this.visitCollectionMode = visitCollectionMode;
+	}
+
 	public VisitNamePrintMode getVisitNamePrintMode() {
 		return visitNamePrintMode != null ? visitNamePrintMode : VisitNamePrintMode.NONE;
 	}
@@ -518,6 +533,7 @@ public void update(CollectionProtocol cp) {
 		setBarcodingEnabled(cp.isBarcodingEnabled());
 		setContainerSelectionStrategy(cp.getContainerSelectionStrategy());
 		setAliquotsInSameContainer(cp.getAliquotsInSameContainer());
+		setVisitCollectionMode(cp.getVisitCollectionMode());
 		setVisitNamePrintMode(cp.getVisitNamePrintMode());
 		setVisitNamePrintCopies(cp.getVisitNamePrintCopies());
 		setUnsignedConsentDocumentURL(cp.getUnsignedConsentDocumentURL());
@@ -557,6 +573,7 @@ public void copyTo(CollectionProtocol cp) {
 		cp.setManualSpecLabelEnabled(isManualSpecLabelEnabled());
 		cp.setBulkPartRegEnabled(isBulkPartRegEnabled());
 		cp.setBarcodingEnabled(isBarcodingEnabled());
+		cp.setVisitCollectionMode(getVisitCollectionMode());
 		cp.setVisitNamePrintMode(getVisitNamePrintMode());
 		cp.setVisitNamePrintCopies(getVisitNamePrintCopies());
 		cp.setSpmnLabelPrePrintMode(getSpmnLabelPrePrintMode());

WEB-INF/src/com/krishagni/catissueplus/core/biospecimen/domain/factory/CpErrorCode.java

@@ -65,6 +65,8 @@ public enum CpErrorCode implements ErrorCode {
 
 	INVALID_SOP_DOC,
 
+	INVALID_VISIT_COLL_MODE,
+
 	INVALID_VISIT_NAME_PRINT_MODE,
 
 	INVALID_SPMN_LABEL_PRE_PRINT_MODE,

WEB-INF/src/com/krishagni/catissueplus/core/biospecimen/domain/factory/impl/CollectionProtocolFactoryImpl.java

@@ -109,6 +109,7 @@ public CollectionProtocol createCollectionProtocol(CollectionProtocolDetail inpu
 		setLabelFormats(input, cp, ose);
 		setBarcodeSetting(input, cp, ose);
 		setContainerSelectionStrategy(input, cp, ose);
+		setVisitCollectionMode(input, cp, ose);
 		setVisitNamePrintMode(input, cp, ose);
 		cp.setVisitNamePrintCopies(input.getVisitNamePrintCopies());
 		setSpecimenLabelPrePrintMode(input, cp, ose);
@@ -369,6 +370,18 @@ private void setContainerSelectionStrategy(CollectionProtocolDetail input, Colle
 		result.setAliquotsInSameContainer(input.getAliquotsInSameContainer());
 	}
 
+	private void setVisitCollectionMode(CollectionProtocolDetail input, CollectionProtocol cp, OpenSpecimenException ose) {
+		if (StringUtils.isBlank(input.getVisitCollectionMode())) {
+			return;
+		}
+
+		try {
+			cp.setVisitCollectionMode(CollectionProtocol.VisitCollectionMode.valueOf(input.getVisitCollectionMode()));
+		} catch (IllegalArgumentException iae) {
+			ose.addError(CpErrorCode.INVALID_VISIT_COLL_MODE, input.getVisitCollectionMode());
+		}
+	}
+
 	private void setVisitNamePrintMode(CollectionProtocolDetail input, CollectionProtocol cp, OpenSpecimenException ose) {
 		if (cp.isSpecimenCentric() || StringUtils.isBlank(input.getVisitNamePrintMode())) {
 			return;

WEB-INF/src/com/krishagni/catissueplus/core/biospecimen/events/CollectionProtocolDetail.java

@@ -55,6 +55,8 @@ public class CollectionProtocolDetail extends CollectionProtocolSummary {
 
 	private Boolean aliquotsInSameContainer;
 
+	private String visitCollectionMode;
+
 	private String visitNamePrintMode;
 
 	private Integer visitNamePrintCopies;
@@ -236,6 +238,14 @@ public void setAliquotsInSameContainer(Boolean aliquotsInSameContainer) {
 		this.aliquotsInSameContainer = aliquotsInSameContainer;
 	}
 
+	public String getVisitCollectionMode() {
+		return visitCollectionMode;
+	}
+
+	public void setVisitCollectionMode(String visitCollectionMode) {
+		this.visitCollectionMode = visitCollectionMode;
+	}
+
 	public String getVisitNamePrintMode() {
 		return visitNamePrintMode;
 	}
@@ -336,6 +346,7 @@ public static CollectionProtocolDetail from(CollectionProtocol cp, boolean fullO
 		result.setBarcodingEnabled(cp.isBarcodingEnabled());
 		result.setContainerSelectionStrategy(cp.getContainerSelectionStrategy());
 		result.setAliquotsInSameContainer(cp.getAliquotsInSameContainer());
+		result.setVisitCollectionMode(cp.getVisitCollectionMode().name());
 		result.setVisitNamePrintMode(cp.getVisitNamePrintMode().name());
 		result.setVisitNamePrintCopies(cp.getVisitNamePrintCopies());
 		result.setSpmnLabelPrePrintMode(cp.getSpmnLabelPrePrintMode().name());

www/app/modules/biospecimen/cp/label-settings.html

@@ -70,6 +70,14 @@
           {{settingCtx.cp.barcodingEnabled | osBoolValue: 'common.enabled': 'common.disabled': 'common.not_specified'}}
         </span>
       </li>
+
+      <li class="item" ng-if="!cp.specimenCentric">
+        <strong class="key key-sm" translate="cp.on_visit_completion">On Visit Completion</strong>
+        <span class="value value-md" ng-switch on="settingCtx.cp.visitCollectionMode">
+          <span ng-switch-when="PRIMARY_SPMNS" translate="cp.coll_primary_spmns">Collect Primary Specimens</span>
+          <span ng-switch-when="ALL_SPMNS" translate="cp.coll_all_spmns">Collect All Specimens</span>
+        </span>
+      </li>
     </ul>
 
     <div class="os-section os-line-section" ng-if="!cp.specimenCentric">
@@ -245,6 +253,22 @@
       </div>
     </div>
 
+    <div class="form-group" ng-if="!cp.specimenCentric">
+      <label class="control-label col-xs-3">
+        <span translate="cp.on_visit_completion">On Visit Completion</span>
+      </label>
+      <div class="col-xs-6">
+        <label class="radio-inline">
+          <input type="radio" name="onVisitCompl" ng-model="settingCtx.cp.visitCollectionMode" ng-value="'PRIMARY_SPMNS'">
+          <span translate="cp.coll_primary_spmns">Collect Primary Specimens</span>
+        </label>
+        <label class="radio-inline">
+          <input type="radio" name="onVisitCompl" ng-model="settingCtx.cp.visitCollectionMode" ng-value="'ALL_SPMNS'">
+          <span translate="cp.coll_all_spmns">Collect All Specimens</span>
+        </label>
+      </div>
+    </div>
+
     <div class="os-section-divider" ng-if="!cp.specimenCentric">
       <span translate="cp.visit_print_settings">Visit Print Settings</span>
     </div>

www/app/modules/i18n/en.js

@@ -186,6 +186,9 @@
     "visit_name_fmt": "Visit Name Format",
     "manual_enabled_for": "User Inputs Allowed For",
     "bulk_part_reg_allowed": "Bulk Registrations",
+    "on_visit_completion": "On Visit Completion",
+    "coll_primary_spmns": "Collect Primary Specimens",
+    "coll_all_spmns": "Collect All Specimens",
     "pre_print_spmn_labels": "Pre-print Labels",
     "ppids": "Participant Protocol IDs",
     "visit_names": "Visit Names",