ru.bitel.bgbilling.kernel.event.events

## Class ChangeTariffByTaskEvent

- java.lang.Object
- - ru.bitel.bgbilling.kernel.event.Event
  - - ru.bitel.bgbilling.kernel.event.QueueEvent
    - - ru.bitel.bgbilling.kernel.event.LocalEvent
      - - ru.bitel.bgbilling.kernel.event.events.ChangeTariffByTaskEvent

- All Implemented Interfaces:
    java.io.Serializable

      public class ChangeTariffByTaskEvent
      extends LocalEvent

  Синхронное событие - Смена тарифа по заданию пользователя.
  Событие вызывается при необходимости смены тарифа через Web.
  Если в событии устанавливается флаг processed, стандартная процедура смены тарифа не производится. Унаследован от `LocalEvent`
  Author:
    shamil
  See Also:
    Serialized Form

- - ### Field Summary

    - ### Fields inherited from class ru.bitel.bgbilling.kernel.event.Event

      `CONTRACT_GLOBAL, NO_MODULE, NO_PLUGIN`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `ChangeTariffByTaskEvent()`
    `` | `ChangeTariffByTaskEvent(int userId, int cid, TariffGroup tariffGroup, ContractTariff fromTariff, TariffPlan toTariff, java.util.Date fromDate)` Конструктор события.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getError()` Возвращает ошибку, установленную скриптом.
    `java.util.Date` | `getFromDate()` Возвращает дату, с которой производится смена тарифов.
    `ContractTariff` | `getFromTariff()` Возвращает тариф, с которого производится переход.
    `java.lang.String` | `getMessage()` Возвращает сообщение, установленное скриптом.
    `TariffGroup` | `getTariffGroup()` Возвращает группу тарифов.
    `TariffPlan` | `getToTariffPlan()` Возвращает тариф, на который производится переход.
    `boolean` | `isProcessed()` Возвращает признак обработанности события скриптом.
    `void` | `setError(java.lang.String error)` Установка ошибки скриптом.
    `void` | `setMessage(java.lang.String message)` Установка сообщения.
    `void` | `setProcessed(boolean processed)` Установка флага обработанности события скриптом.

    - ### Methods inherited from class ru.bitel.bgbilling.kernel.event.Event

      `getContractId, getContractID, getDestination, getGenerateTime, getModuleId, getModuleID, getPluginId, getSuperContractId, getTime, getTimestamp, getTypeId, getUserId, prepareMessage, toString, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ChangeTariffByTaskEvent

          protected ChangeTariffByTaskEvent()

    - #### ChangeTariffByTaskEvent

          public ChangeTariffByTaskEvent(int userId,
                                         int cid,
                                         TariffGroup tariffGroup,
                                         ContractTariff fromTariff,
                                         TariffPlan toTariff,
                                         java.util.Date fromDate)

      Конструктор события.
      Parameters:
        `userId` - - id пользователя, сгенерировавшего событие
        `cid` - - id договора
        `tariffGroup` - - группа тарифа
        `fromTariff` - - id тарифа с которого переключается ползователь
        `toTariff` - - id тарифа на который переключается пользователь
        `fromDate` - - дата, с которой производится смена тарифов.

  - ### Method Detail

    - #### getTariffGroup

          public TariffGroup getTariffGroup()

      Возвращает группу тарифов.
      Returns:
        tariffGroup - группа тарифов

    - #### getFromTariff

          public ContractTariff getFromTariff()

      Возвращает тариф, с которого производится переход.
      Returns:
        fromTariff - тариф договора

    - #### getToTariffPlan

          public TariffPlan getToTariffPlan()

      Возвращает тариф, на который производится переход.
      Returns:
        fromTariff - тариф договора

    - #### isProcessed

          public boolean isProcessed()

      Возвращает признак обработанности события скриптом. В этом случае штатная смена тарифа не выполняется.
      Returns:
        processed - признак обработанности события. true - обработано, false - не обработано.

    - #### setProcessed

          public void setProcessed(boolean processed)

      Установка флага обработанности события скриптом.
      Parameters:
        `processed` - - флаг обработанности события скриптом

    - #### getMessage

          public java.lang.String getMessage()

      Возвращает сообщение, установленное скриптом.
      Returns:
        message - сообщение

    - #### setMessage

          public void setMessage(java.lang.String message)

      Установка сообщения.
      Parameters:
        `message` - - сообщение

    - #### getError

          public java.lang.String getError()

      Возвращает ошибку, установленную скриптом.
      Returns:
        error ошибка

    - #### setError

          public void setError(java.lang.String error)

      Установка ошибки скриптом.
      Parameters:
        `error` - - ошибка

    - #### getFromDate

          public java.util.Date getFromDate()

      Возвращает дату, с которой производится смена тарифов.
      Returns:
        fromDate - дата