Filter Templates field when Sample Type is selected in Sample Add form

CHANGES.rst

@@ -7,6 +7,7 @@ Changelog
 
 **Added**
 
+- #1481 Filter Templates field when Sample Type is selected in Sample Add form
 - #1483 Added Accredited symbol in Analyses listings
 - #1466 Support for "readonly" and "hidden" visibility modes in ReferenceWidget
 

bika/lims/browser/analysisrequest/add2.py

@@ -1013,16 +1013,24 @@ def get_sampletype_info(self, obj):
         })
 
         # catalog queries for UI field filtering
+        sample_type_uid = api.get_uid(obj)
         filter_queries = {
+            # Display Sample Points that have this sample type assigned plus
+            # those that do not have a sample type assigned
             "SamplePoint": {
-                "getSampleTypeTitles": [obj.Title(), ''],
+                "sampletype_uids": [sample_type_uid, None],
                 "getClientUID": [client_uid, ""],
-                "sort_order": "descending",
             },
+            # Display Specifications that have this sample type assigned only
             "Specification": {
-                "getSampleTypeTitle": obj.Title(),
+                "sampletype_uids": sample_type_uid,
+                "getClientUID": [client_uid, ""],
+            },
+            # Display AR Templates that have this sample type assigned plus
+            # those that do not have a sample type assigned
+            "Template": {
+                "sampletype_uids": [sample_type_uid, None],
                 "getClientUID": [client_uid, ""],
-                "sort_order": "descending",
             }
         }
         info["filter_queries"] = filter_queries
@@ -1152,7 +1160,8 @@ def ajax_get_flush_settings(self):
             ],
             "SampleType": [
                 "SamplePoint",
-                "Specification"
+                "Specification",
+                "Template",
             ],
             "PrimarySample": [
                 "Batch"

bika/lims/catalog/indexers/bikasetup.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of SENAITE.CORE.
+#
+# SENAITE.CORE is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 2.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright 2018-2019 by it's authors.
+# Some rights reserved, see README and LICENSE.
+
+from plone.indexer import indexer
+
+from bika.lims.interfaces import IBikaSetupCatalog
+from bika.lims.interfaces import ISampleTypeAwareMixin
+
+
+@indexer(ISampleTypeAwareMixin, IBikaSetupCatalog)
+def sampletype_uids(instance):
+    """Returns the list of SampleType UIDs the instance is assigned to
+
+    This is a KeywordIndex, so it will be indexed as a list, even if only one
+    SampleType can be assigned to the instance. Moreover, if the instance has no
+    SampleType assigned, it returns a tuple with a None value. This allows
+    searches for `MissingValue` entries too.
+    """
+    return instance.getSampleTypeUID() or (None, )

bika/lims/catalog/indexers/configure.zcml

@@ -24,6 +24,14 @@
   <!-- Whether the object is neither cancelled nor invalid -->
   <adapter name="is_active" factory=".is_active"/>
 
+
+  <!-- BikaSetup Catalog Index adapters -->
+
+  <!-- sampletype_uids: used in Add Sample form to filter Sample Points,
+  Specifications and Templates when a Sample Type is selected -->
+  <adapter name="sampletype_uids" factory=".bikasetup.sampletype_uids"/>
+
+
   <!-- Auditlog Catalog Index Adapters -->
   <adapter name="action" factory=".auditlog.action"/>
   <adapter name="actor" factory=".auditlog.actor"/>

bika/lims/content/analysisrequest.py

@@ -690,7 +690,7 @@
                  'width': '30',
                  'label': _('Title'),
                  'align': 'left'},
-                {'columnName': 'SampleTypeTitle',
+                {'columnName': 'getSampleTypeTitle',
                  'width': '70',
                  'label': _('SampleType'),
                  'align': 'left'},

bika/lims/content/analysisspec.py

@@ -19,29 +19,27 @@
 # Some rights reserved, see README and LICENSE.
 
 from AccessControl import ClassSecurityInfo
-from bika.lims import api
-from bika.lims import bikaMessageFactory as _
-from bika.lims.browser.fields import UIDReferenceField
-from bika.lims.browser.widgets import AnalysisSpecificationWidget
-from bika.lims.config import PROJECTNAME
-from bika.lims.content.bikaschema import BikaSchema
-from bika.lims.content.clientawaremixin import ClientAwareMixin
-from bika.lims.interfaces import IAnalysisSpec, IDeactivable
+from Products.ATContentTypes.lib.historyaware import HistoryAwareMixin
+from Products.ATExtensions.field.records import RecordsField
 from Products.Archetypes import atapi
 from Products.Archetypes.public import BaseFolder
-from Products.Archetypes.public import ComputedField
-from Products.Archetypes.public import ComputedWidget
 from Products.Archetypes.public import ReferenceWidget
 from Products.Archetypes.public import Schema
 from Products.Archetypes.utils import DisplayList
-from Products.ATContentTypes.lib.historyaware import HistoryAwareMixin
-from Products.ATExtensions.field.records import RecordsField
-from Products.CMFCore.utils import getToolByName
 from Products.CMFPlone.utils import safe_unicode
 from zope.i18n import translate
 from zope.interface import implements
 
-from bika.lims.interfaces import IClient
+from bika.lims import api
+from bika.lims import bikaMessageFactory as _
+from bika.lims.browser.fields import UIDReferenceField
+from bika.lims.browser.widgets import AnalysisSpecificationWidget
+from bika.lims.config import PROJECTNAME
+from bika.lims.content.bikaschema import BikaSchema
+from bika.lims.content.clientawaremixin import ClientAwareMixin
+from bika.lims.content.sampletype import SampleTypeAwareMixin
+from bika.lims.interfaces import IAnalysisSpec
+from bika.lims.interfaces import IDeactivable
 
 schema = Schema((
 
@@ -55,21 +53,6 @@
         ),
     ),
 
-    ComputedField(
-        'SampleTypeTitle',
-        expression="context.getSampleType().Title() if context.getSampleType() else ''",
-        widget=ComputedWidget(
-            visible=False,
-        ),
-    ),
-
-    ComputedField(
-        'SampleTypeUID',
-        expression="context.getSampleType().UID() if context.getSampleType() else ''",
-        widget=ComputedWidget(
-            visible=False,
-        ),
-    ),
 )) + BikaSchema.copy() + Schema((
 
     RecordsField(
@@ -119,21 +102,14 @@
                 "in lists and results reports instead of the real result.")
         ),
     ),
-
-    ComputedField(
-        'ClientUID',
-        expression="context.aq_parent.UID()",
-        widget=ComputedWidget(
-            visible=False,
-        ),
-    ),
 ))
 
 schema['description'].widget.visible = True
 schema['title'].required = True
 
 
-class AnalysisSpec(BaseFolder, HistoryAwareMixin, ClientAwareMixin):
+class AnalysisSpec(BaseFolder, HistoryAwareMixin, ClientAwareMixin,
+                   SampleTypeAwareMixin):
     """Analysis Specification
     """
     implements(IAnalysisSpec, IDeactivable)
@@ -155,9 +131,7 @@ def Title(self):
         if self.title:
             title = self.title
         else:
-            sampletype = self.getSampleType()
-            if sampletype:
-                title = sampletype.Title()
+            title = self.getSampleTypeTitle() or ""
         return safe_unicode(title).encode('utf-8')
 
     def contextual_title(self):

bika/lims/content/artemplate.py

@@ -21,17 +21,7 @@
 import sys
 
 from AccessControl import ClassSecurityInfo
-from bika.lims import api
-from bika.lims import bikaMessageFactory as _
-from bika.lims.browser.fields.remarksfield import RemarksField
-from bika.lims.browser.widgets import ARTemplateAnalysesWidget
-from bika.lims.browser.widgets import ARTemplatePartitionsWidget
-from bika.lims.browser.widgets import ReferenceWidget
-from bika.lims.browser.widgets import RemarksWidget
-from bika.lims.config import PROJECTNAME
-from bika.lims.content.bikaschema import BikaSchema
-from bika.lims.content.clientawaremixin import ClientAwareMixin
-from bika.lims.interfaces import IARTemplate, IDeactivable
+from Products.ATExtensions.field.records import RecordsField
 from Products.Archetypes.public import BaseContent
 from Products.Archetypes.public import BooleanField
 from Products.Archetypes.public import BooleanWidget
@@ -42,10 +32,23 @@
 from Products.Archetypes.public import Schema
 from Products.Archetypes.public import registerType
 from Products.Archetypes.references import HoldingReference
-from Products.ATExtensions.field.records import RecordsField
 from Products.CMFCore.utils import getToolByName
 from zope.interface import implements
 
+from bika.lims import api
+from bika.lims import bikaMessageFactory as _
+from bika.lims.browser.fields.remarksfield import RemarksField
+from bika.lims.browser.widgets import ARTemplateAnalysesWidget
+from bika.lims.browser.widgets import ARTemplatePartitionsWidget
+from bika.lims.browser.widgets import ReferenceWidget
+from bika.lims.browser.widgets import RemarksWidget
+from bika.lims.config import PROJECTNAME
+from bika.lims.content.bikaschema import BikaSchema
+from bika.lims.content.clientawaremixin import ClientAwareMixin
+from bika.lims.content.sampletype import SampleTypeAwareMixin
+from bika.lims.interfaces import IARTemplate
+from bika.lims.interfaces import IDeactivable
+
 schema = BikaSchema.copy() + Schema((
     ReferenceField(
         "SamplePoint",
@@ -96,13 +99,6 @@
             showOn=True,
         ),
     ),
-    ComputedField(
-        "SampleTypeUID",
-        expression="context.Schema()['SampleType'].get(context) and context.Schema()['SampleType'].get(context).UID() or ''",
-        widget=ComputedWidget(
-            visible=False,
-        ),
-    ),
     BooleanField(
         "Composite",
         default=False,
@@ -300,7 +296,7 @@
 schema["title"]._validationLayer()
 
 
-class ARTemplate(BaseContent, ClientAwareMixin):
+class ARTemplate(BaseContent, ClientAwareMixin, SampleTypeAwareMixin):
     security = ClassSecurityInfo()
     schema = schema
     displayContentsTab = False

bika/lims/content/samplepoint.py

@@ -25,7 +25,6 @@
 from Products.Archetypes.public import BaseContent
 from Products.Archetypes.public import BooleanField
 from Products.Archetypes.public import BooleanWidget
-from Products.Archetypes.public import DisplayList
 from Products.Archetypes.public import FileWidget
 from Products.Archetypes.public import ReferenceField
 from Products.Archetypes.public import Schema
@@ -34,8 +33,10 @@
 from Products.Archetypes.public import registerType
 from Products.CMFCore.utils import getToolByName
 from Products.CMFPlone.utils import safe_unicode
+from plone.app.blob.field import FileField as BlobFileField
+from zope.interface import implements
+
 from bika.lims import bikaMessageFactory as _
-from bika.lims import deprecated
 from bika.lims.browser.fields import CoordinateField
 from bika.lims.browser.fields import DurationField
 from bika.lims.browser.widgets import CoordinateWidget
@@ -45,9 +46,8 @@
 from bika.lims.config import PROJECTNAME
 from bika.lims.content.bikaschema import BikaSchema
 from bika.lims.content.clientawaremixin import ClientAwareMixin
+from bika.lims.content.sampletype import SampleTypeAwareMixin
 from bika.lims.interfaces import IDeactivable
-from plone.app.blob.field import FileField as BlobFileField
-from zope.interface import implements
 
 schema = BikaSchema.copy() + Schema((
     CoordinateField(
@@ -91,13 +91,17 @@
         required=0,
         multiValued=1,
         allowed_types=('SampleType',),
-        vocabulary='SampleTypesVocabulary',
         relationship='SamplePointSampleType',
         widget=BikaReferenceWidget(
             label=_("Sample Types"),
             description=_("The list of sample types that can be collected "
                           "at this sample point.  If no sample types are "
                           "selected, then all sample types are available."),
+            catalog_name='bika_setup_catalog',
+            base_query={"is_active": True,
+                        "sort_on": "sortable_title",
+                        "sort_order": "ascending"},
+            showOn=True,
         ),
     ),
 
@@ -126,7 +130,8 @@
 schema['description'].schemata = 'default'
 
 
-class SamplePoint(BaseContent, HistoryAwareMixin, ClientAwareMixin):
+class SamplePoint(BaseContent, HistoryAwareMixin, ClientAwareMixin,
+                  SampleTypeAwareMixin):
     implements(IDeactivable)
     security = ClassSecurityInfo()
     displayContentsTab = False
@@ -141,31 +146,6 @@ def _renameAfterCreation(self, check_auto_id=False):
     def Title(self):
         return safe_unicode(self.getField('title').get(self)).encode('utf-8')
 
-    def getSampleTypeTitles(self):
-        """Returns a list of sample type titles
-        """
-        sample_types = self.getSampleTypes()
-        sample_type_titles = map(lambda obj: obj.Title(), sample_types)
-
-        # N.B. This is used only for search purpose, because the catalog does
-        #      not add an entry to the Keywordindex for an empty list.
-        #
-        # => This "empty" category allows to search for values with a certain
-        #    sample type set OR with no sample type set.
-        #    (see bika.lims.browser.analysisrequest.add2.get_sampletype_info)
-        if not sample_type_titles:
-            return [""]
-        return sample_type_titles
-
-    def getSampleTypeTitle(self):
-        """Returns a comma separated list of sample type titles
-        """
-        return ",".join(self.getSampleTypeTitles())
-
-    def SampleTypesVocabulary(self):
-        from bika.lims.content.sampletype import SampleTypes
-        return SampleTypes(self, allow_blank=False)
-
     def setSampleTypes(self, value, **kw):
         """ For the moment, we're manually trimming the sampletype<>samplepoint
             relation to be equal on both sides, here.
@@ -200,31 +180,5 @@ def setSampleTypes(self, value, **kw):
 
         return ret
 
-    def getSampleTypes(self, **kw):
-        return self.Schema()['SampleTypes'].get(self)
-
 
 registerType(SamplePoint, PROJECTNAME)
-
-
-@deprecated("bika.lims.content.samplepoint.SamplePoints function will be removed in senaite.core 1.2.0")
-def SamplePoints(self, instance=None, allow_blank=True, lab_only=True):
-    instance = instance or self
-    bsc = getToolByName(instance, 'bika_setup_catalog')
-    items = []
-    contentFilter = {
-        'portal_type': 'SamplePoint',
-        'is_active': True,
-        'sort_on': 'sortable_title'}
-    if lab_only:
-        lab_path = instance.bika_setup.bika_samplepoints.getPhysicalPath()
-        contentFilter['path'] = {"query": "/".join(lab_path), "level": 0}
-    for sp in bsc(contentFilter):
-        sp = sp.getObject()
-        if sp.aq_parent.portal_type == 'Client':
-            sp_title = "{}: {}".format(sp.aq_parent.Title(), sp.Title())
-        else:
-            sp_title = sp.Title()
-        items.append((sp.UID(), sp_title))
-    items = allow_blank and [['', '']] + list(items) or list(items)
-    return DisplayList(items)