ExtraValues
========================

For the AddExtraValue\* functions below,
if the ExtraValue already exists on a person's record,
it will update it with this new value,
otherwise it will add a new extra value to the person's record

.. py:function:: model.AddExtraValueBool(query, name, truefalse)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param bool truefalse: The boolean value (True or False)

.. py:function:: model.AddExtraValueCode(query, name, code)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param str code: The code value (text)

.. py:function:: model.AddExtraValueDate(query, name, date)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param date date,str: The date value

.. py:function:: model.AddExtraValueInt(query, name, number)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param str number: The integer value (not in quotes)

.. py:function:: model.AddExtraValueText(query, name, text)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param str text: The text value

.. py:function:: model.AddExtraValueAttributes(query, name, text)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field
    :param str text: The JSON text value

    Extra Value Attributes are intended for json text.

.. py:function:: model.ExtraValue(peopleid, name)

    :return: The extra value for the indicated person
    :rtype: str
    :param int peopleid:
    :param str name: The name of the Extra Value Field

    This function returns the extra value as a string,
    without having to specify the type.

.. py:function:: model.ExtraValueBit(peopleid, name)

    :return: The bool value for the indicated person
    :rtype: bool
    :param int peopleid:
    :param str name: The name of the Extra Value Field

.. py:function:: model.ExtraValueCode(peopleid, name)

    :return: The code extra value for the indicated person
    :rtype: str
    :param int peopleid:
    :param str name: The name of the Extra Value Field

.. py:function:: model.ExtraValueDate(peopleid, name)

    :return: The date extra value for the indicated person
    :rtype: date
    :param int peopleid:
    :param str name: The name of the Extra Value Field

.. py:function:: model.ExtraValueInt(peopleid, name)

    :return: The int extra value for the indicated person
    :rtype: int
    :param int peopleid:
    :param str name: The name of the Extra Value Field

.. py:function:: model.ExtraValueText(peopleid, name)

    :return: The text value for the indicated person
    :rtype: str
    :param int peopleid:
    :param str name: The name of the Extra Value Field

.. py:function:: model.ExtraValueAttributes(peopleid, name)

    :return: The text value for the indicated person
    :rtype: str
    :param int peopleid:
    :param str name: The name of the Extra Value Field

    This will only return a value if the IsAttribute flag is set on the extra value.
    The only way this value is set is using the AddExtraValueAttributes.

.. py:function:: model.DeleteExtraValue(query, name)

    :param str query: see :doc:`QueryParameter`
    :param str name: The name of the Extra Value Field to delete

.. py:function:: model.DeleteAllExtraValueLike(search)

    :param str query: see :doc:`QueryParameter`
    :param str search: The text to be searched

    This is useful if you have an extra value that has a pattern
    and it works on the entire database.
    
    For example, if you have a value that begins with something like 'BP:',
    then you would use ``model.DeleteAllExtraValueLike('BP:%')``.