Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1#!/usr/local/bin/python
2# encoding: utf-8
3"""
4*The data model module for the `xmatches_element_searches_get` resource*
6:Author:
7 David Young
8"""
9import sys
10import os
11import khufu
12from marshall_webapp.models.transients.models_transients_get import models_transients_get
14class models_xmatches_element_searches_get(models_transients_get):
15 """
16 The worker class for the models_xmatches_element_searches_get module
18 **Key Arguments**
20 - ``log`` -- logger
21 - ``request`` -- the pyramid request
22 - ``elementId`` -- the specific element id requests (or False)
23 - ``search`` -- is this a search request (boolean)
25 """
27 def __init__(
28 self,
29 log,
30 request,
31 elementId=False,
32 search=False
33 ):
34 self.log = log
35 self.request = request
36 self.elementId = elementId
37 self.search = search
38 self.qs = dict(request.params) # the query string
39 # the query string defaults
40 self.defaultQs = {}
41 # xt-self-arg-tmpx
43 log.debug(
44 "instansiating a new 'models_xmatches_element_searches_get' object")
46 # Variable Data Atrributes
48 # Initial Actions
49 self._set_default_parameters()
51 return None
53 def get(self):
54 """execute the get method on the models_xmatches_element_searches_get object
56 **Return**
58 - ``responseContent`` -- the reponse to send to the browser
60 """
61 self.log.debug('starting the ``get`` method')
63 elementId = self.elementId
65 responseContent = "Response from <code>" + __name__ + "</code><BR><BR>"
66 if elementId:
67 responseContent = "%(responseContent)sThe element selected was </code>%(elementId)s</code>" % locals(
68 )
69 else:
70 responseContent = "%(responseContent)sResource Context selected (no element)" % locals(
71 )
73 self.log.debug('completed the ``get`` method')
74 return responseContent
76 def _set_default_parameters(
77 self):
78 """ set default parameters
79 """
80 self.log.debug('starting the ``_set_default_parameters`` method')
82 for k, v in list(self.defaultQs.items()):
83 if k not in self.qs:
84 self.qs[k] = v
86 self.log.debug('completed the ``_set_default_parameters`` method')
87 return None
89 # xt-class-method