register Register/Refer a preference in the system for any module. :param module: Name of the module :param category: Name of category :param name: Name of the option :param label: Label of the option, shown in the preferences. :para
(
cls, module, category, name, label, _type, **kwargs
)
| 501 | |
| 502 | @classmethod |
| 503 | def register_preference( |
| 504 | cls, module, category, name, label, _type, **kwargs |
| 505 | ): |
| 506 | """ |
| 507 | register |
| 508 | Register/Refer a preference in the system for any module. |
| 509 | |
| 510 | :param module: Name of the module |
| 511 | :param category: Name of category |
| 512 | :param name: Name of the option |
| 513 | :param label: Label of the option, shown in the preferences. |
| 514 | :param _type: Type of the option. |
| 515 | Allowed type of options are as below: |
| 516 | boolean, integer, numeric, date, datetime, |
| 517 | options, multiline, switch, node |
| 518 | """ |
| 519 | default = kwargs.get('default') |
| 520 | min_val = kwargs.get('min_val', None) |
| 521 | max_val = kwargs.get('max_val', None) |
| 522 | options = kwargs.get('options', None) |
| 523 | help_str = kwargs.get('help_str', None) |
| 524 | control_props = kwargs.get('control_props', None) |
| 525 | module_label = kwargs.get('module_label', None) |
| 526 | category_label = kwargs.get('category_label', None) |
| 527 | |
| 528 | if module in Preferences.modules: |
| 529 | m = Preferences.modules[module] |
| 530 | # Update the label (if not defined yet) |
| 531 | m.label = m.label or module_label |
| 532 | else: |
| 533 | m = Preferences(module, module_label) |
| 534 | |
| 535 | return m.register( |
| 536 | category, name, label, _type, default, min_val=min_val, |
| 537 | max_val=max_val, options=options, help_str=help_str, |
| 538 | control_props=control_props, |
| 539 | category_label=category_label |
| 540 | ) |
| 541 | |
| 542 | @staticmethod |
| 543 | def raw_value(_module, _preference, _category=None, _user_id=None): |
nothing calls this directly
no test coverage detected