##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#                    Sebastien Robin <seb@nexedi.com>
#
# 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.
#
##############################################################################

class Alarm:
    """
        Properties which allow to define a generic Alarm.

        An alarm can be used to trigger an action periodically.
    """

    _properties = (
        {   'id'          : 'report_method_id',
            'description' : 'the method used to display information',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'active_sense_method_id',
            'description' : 'the method used to check things',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'sense_method_id',
            'description' : 'the method used to know if there is a problem',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'solve_method_id',
            'description' : 'the method used to solve problems if any.',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'notification_method_id',
            'description' : 'the method used to notify results.',
            'type'        : 'string',
            'mode'        : 'w' },
        {   'id'          : 'alarm_notification_mode',
            'description' : 'defines the notification mode of an Alarm.'
                            'Never, on sense or always.',
            'type'        : 'selection',
            'select_variable' : 'getAlarmNotificationModeSelectionList',
            'mode'        : 'w' },
        {   'id'          : 'alarm_notification_mode_selection',
            'description' : 'List of possible values for alarm_notification_mode',
            'type'        : 'tokens',
            'default'     : ['always','sense','never'],
            'mode'        : ''},
    )

    _categories = ( 'group', 'site', # XXX Why ?
                    'destination')

