Entity.py 18.2 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program 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; either version 2
# of the License, or (at your option) any later version.
#
# 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Products.ERP5Type.Utils import assertAttributePortalType
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
32 33
from Products.CMFCore.WorkflowCore import WorkflowMethod
from Products.CMFCore.utils import getToolByName
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

class Entity:
    """
        Mix-in class used by Organisation and Person

        Implements accessors to:

        - default_telephone

        - default_fax

        - default_email

        - default_address
    """

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.View)

    security.declareProtected(Permissions.View, 'getDefaultAddressText')
    def getDefaultAddressText(self):
        """
          Returns the default address as a text string
        """
        try:
          return self.getDefaultAddressValue().asText()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultAddressStreetAddress')
    def getDefaultAddressStreetAddress(self):
        """
          Returns the default address street as a text string
        """
        try:
          return self.getDefaultAddressValue().getStreetAddress()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultAddressCity')
    def getDefaultAddressCity(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultAddressValue().getCity()
        except:
          return ''

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    security.declareProtected(Permissions.View, 'getDefaultCareerTitle')
    def getDefaultCareerTitle(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getTitle()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultCareerDestinationTitle')
    def getDefaultCareerDestinationTitle(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getDestinationTitle()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultCareerStartDate')
    def getDefaultCareerStartDate(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getStartDate()
        except:
112
          return None
113 114 115 116 117 118 119 120 121

    security.declareProtected(Permissions.View, 'getDefaultCareerStopDate')
    def getDefaultCareerStopDate(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getStopDate()
        except:
122
          return None
123 124 125 126 127 128 129 130 131 132 133

    security.declareProtected(Permissions.View, 'getDefaultCareerDescription')
    def getDefaultCareerDescription(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getDescription()
        except:
          return ''

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    security.declareProtected(Permissions.View, 'getDefaultCareerSalaryLevel')
    def getDefaultCareerSalaryLevel(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getSalaryLevel()
        except:
          return ''
        
    security.declareProtected(Permissions.View, 'getDefaultCareerSalaryCoefficient')
    def getDefaultCareerSalaryCoefficient(self):
        """
          Returns the default address city as a text string
        """
        try:
          return self.getDefaultCareerValue().getSalaryCoefficient()
        except:
          return ''                                                                               
        
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
    security.declareProtected(Permissions.View, 'getDefaultAddressRegion')
    def getDefaultAddressRegion(self):
        """
          Returns the default address region as a text string
        """
        try:
         return self.getDefaultAddressValue().getRegion()
        except:
         return ''

    security.declareProtected(Permissions.View, 'getDefaultAddressZipCode')
    def getDefaultAddressZipCode(self):
        """
          Returns the default address zip code as a text string
        """
        try:
          return self.getDefaultAddressValue().getZipCode()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultTelephoneText')
    def getDefaultTelephoneText(self):
        """
          Returns the default telephone as a text string
        """
        try:
          return self.getDefaultTelephone().asText()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultFaxText')
    def getDefaultFaxText(self):
        """
          Returns the default fax as a text string
        """
        try:
          return self.getDefaultFax().asText()
        except:
          return ''

    security.declareProtected(Permissions.View, 'getDefaultEmailText')
    def getDefaultEmailText(self):
        """
          Returns the default email as a text string
        """
        try:
          return self.getDefaultEmail().asText()
        except:
          return ''

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddress')
    def setDefaultAddress(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddress(coordinate)
        self.reindexObject()

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerTitle')
    def setDefaultCareerTitle(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerTitle(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerDescription')
    def setDefaultCareerDescription(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerDescription(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerStartDate')
    def setDefaultCareerStartDate(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerStartDate(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerStopDate')
    def setDefaultCareerStopDate(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerStopDate(coordinate)
        self.reindexObject()

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerSalaryLevel')
    def setDefaultCareerSalaryLevel(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerSalaryLevel(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultCareerSalaryCoefficient')
    def setDefaultCareerSalaryCoefficient(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultCareerSalaryCoefficient(coordinate)
        self.reindexObject()                                                    
                                                                                                        
Jean-Paul Smets's avatar
Jean-Paul Smets committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddressText')
    def setDefaultAddressText(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddressText(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddressRegion')
    def setDefaultAddressRegion(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddressRegion(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddressCity')
    def setDefaultAddressCity(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddressCity(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddressZipCode')
    def setDefaultAddressZipCode(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddressZipCode(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultAddressStreetAddress')
    def setDefaultAddressStreetAddress(self, coordinate):
        """
          Updates the default address from a standard text string
        """
        self._setDefaultAddressStreetAddress(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultTelephoneText')
    def setDefaultTelephoneText(self, coordinate):
        """
          Updates the default telephone from a standard text string
        """
        self._setDefaultTelephoneText(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultFaxText')
    def setDefaultFaxText(self, coordinate):
        """
          Updates the default fax from a standard text string
        """
        self._setDefaultFaxText(coordinate)
        self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'setDefaultEmailText')
    def setDefaultEmailText(self, coordinate):
        """
          Updates the default email from a standard text string
        """
        self._setDefaultEmailText(coordinate)
        self.reindexObject()

    ### Private methods - no reindexing
    security.declarePrivate('_setDefaultAddress')
    def _setDefaultAddress(self, coordinate):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address = coordinate

    security.declarePrivate('_setDefaultAddressText')
    def _setDefaultAddressText(self, coordinate):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address.fromText(coordinate)

    security.declarePrivate('_setDefaultAddressCity')
    def _setDefaultAddressCity(self, value):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address.setCity(value)

    security.declarePrivate('_setDefaultAddressZipCode')
    def _setDefaultAddressZipCode(self, value):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address.setZipCode(value)

    security.declarePrivate('_setDefaultAddressStreetAddress')
    def _setDefaultAddressStreetAddress(self, value):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address.setStreetAddress(value)

    security.declarePrivate('_setDefaultAddressRegion')
    def _setDefaultAddressRegion(self, value):
        assertAttributePortalType(self, 'default_address', 'Address')
        if not hasattr(self,'default_address'):
          self.invokeFactory( type_name='Address'
                            , id='default_address'
                            )
        self.default_address.setRegion(value)

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    security.declarePrivate('_setDefaultCareerTitle')
    def _setDefaultCareerTitle(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setTitle(coordinate)

    security.declarePrivate('_setDefaultCareerDescription')
    def _setDefaultCareerDescription(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setDescription(coordinate)

    security.declarePrivate('_setDefaultCareerStartDate')
    def _setDefaultCareerStartDate(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setStartDate(coordinate)

    security.declarePrivate('_setDefaultCareerStopDate')
    def _setDefaultCareerStopDate(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setStopDate(coordinate)

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    security.declarePrivate('_setDefaultCareerSalaryLevel')
    def _setDefaultCareerSalaryLevel(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setSalaryLevel(coordinate)
                                              
    security.declarePrivate('_setDefaultCareerSalaryCoefficient')
    def _setDefaultCareerSalaryCoefficient(self, coordinate):
        assertAttributePortalType(self, 'default_career', 'Career')
        if not hasattr(self,'default_career'):
          self.invokeFactory( type_name='Career'
                            , id='default_career'
                            )
        self.default_career.setSalaryCoefficient(coordinate)
                                            
Jean-Paul Smets's avatar
Jean-Paul Smets committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
    security.declarePrivate('_setDefaultTelephoneText')
    def _setDefaultTelephoneText(self, coordinate):
        assertAttributePortalType(self, 'default_telephone', 'Telephone')
        if not hasattr(self,'default_telephone'):
          self.invokeFactory( type_name='Telephone'
                            , id='default_telephone'
                            )
        self.default_telephone.fromText(coordinate)

    security.declarePrivate('_setDefaultFaxText')
    def _setDefaultFaxText(self, coordinate):
        assertAttributePortalType(self, 'default_fax', 'Fax')
        if not hasattr(self,'default_fax'):
          self.invokeFactory( type_name='Fax'
                            , id='default_fax'
                            )
        self.default_fax.fromText(coordinate)

    security.declarePrivate('_setDefaultEmailText')
    def _setDefaultEmailText(self, coordinate):
        assertAttributePortalType(self, 'default_email', 'Email')
        if not hasattr(self,'default_email'):
          self.invokeFactory( type_name='Email'
                            , id='default_email'
                            )
        self.default_email.fromText(coordinate)

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
    security.declareProtected(Permissions.ModifyPortalContent, 'validate')
    def validate(self):
      """
        Sets the entity to validated
      """
      pass

    validate = WorkflowMethod(validate)

    security.declareProtected(Permissions.ModifyPortalContent, 'invalidate')
    def invalidate(self):
      """
        Sets the entity to invalidated
      """
      pass

    invalidate = WorkflowMethod(invalidate)

    security.declareProtected(Permissions.AccessContentsInformation, 'getValidationState')
    def getValidationState(self, id_only=1):
      """
        Returns the current state in validation
      """
      portal_workflow = getToolByName(self, 'portal_workflow')
      wf = portal_workflow.getWorkflowById('validation_workflow')
      return wf._getWorkflowStateOf(self, id_only=id_only )