Package ru.bitel.bgbilling.plugins.dispatch.common.bean

# Class Subscription

java.lang.Object
ru.bitel.common.model.Id
ru.bitel.bgbilling.plugins.dispatch.common.bean.Subscription

All Implemented Interfaces:
  `Serializable`, `Contractable`, `Idable`

public class Subscription extends Id implements Contractable
Подписка на рассылку

See Also:
  - Serialized Form

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Subscription()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addContact(Contact contact)`
  Добавление контакта к списку контактов для данной подписки
  `String`
  `getComment()`
  Возвращает комментарий к подписке
  `String`
  `getContactHash(Contact contact)`
  Получение хэша подписки для определенного контакта.
  `List<Contact>`
  `getContacts()`
  Возвращает список контактов, которые подписаны на рассылку
  `int`
  `getContractId()`
  Возвращает код договора
  `String`
  `getContractTitle()`
  Возвращает название договора
  `Dispatch`
  `getDispatch()`
  Возвращает рассылку, на которую осуществлена данная подписка
  `String`
  `getHumanReadableRepeatTime()`
  `Preferences`
  `getPreferences()`
  Возвращает настройки подписки
  `ScheduleTime`
  `getRepeatTime()`
  Возвращает расписание времени отправки для персональных рассылок
  `String`
  `getRepeatTimeDaysOfWeek()`
  Возвращает строку дней недели персональной подписки для отображения в вебе.
  `Period`
  `getSubscriptionPeriod()`
  Возвращает период действия подписки.
  `ScheduleTime`
  `getTotalRepeatTime()`
  Возвращает итоговое расписание, по которому будут приходить сообщения рассылки.
  `boolean`
  `isActive()`
  Активна ли рассылка
  `boolean`
  `isUpdate()`
  `Subscription`
  `setActive(boolean active)`
  Устанавливает флаг активности подписки.
  `Subscription`
  `setComment(String comment)`
  Устанавливает комментарий к подписке
  `Subscription`
  `setContacts(List<Contact> contacts)`
  Устанавливает список контактов, подписанных на рассылку
  `Subscription`
  `setContractId(int contractId)`
  Устанавливает код договора
  `Subscription`
  `setContractTitle(String contractTitle)`
  Устанавливает название договора
  `Subscription`
  `setDispatch(Dispatch dispatch)`
  Устанавливает рассылку, на которую осуществленая данная подписка
  `Subscription`
  `setPreferences(Preferences prefs)`
  Устанавливает настройки подписки
  `Subscription`
  `setRepeatTime(ScheduleTime recieveTime)`
  Устанавливает расписание времени отправки для персоналных рассылок
  `Subscription`
  `setSubscriptionPeriod(Period subscriptionPeriod)`
  Устанавливает период действия подписки.
  `Subscription`
  `setUpdate(boolean update)`

  ### Methods inherited from class ru.bitel.common.model.Id

  `copyTo, equals, getId, hashCode, newIdList, newIdSet, newIdSet, newIdSet, newIdSet, newMap, setId, toString`

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

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

- ## Constructor Details

  - ### Subscription

    public Subscription()

- ## Method Details

  - ### addContact

    public void addContact(Contact contact)
    Добавление контакта к списку контактов для данной подписки
    Parameters:
      `contact` - контакт

  - ### getComment

    public String getComment()
    Возвращает комментарий к подписке
    Returns:

  - ### getContactHash

    public String getContactHash(Contact contact)
    Получение хэша подписки для определенного контакта. Хеш необходим для возможности отписки от рассылки по ссылке в email. Хеш формируется как MD5 от строки "<код подписки>+<код контакта>".
    Parameters:
      `contact` - контакт, для которого необходимо получить хеш
    Returns:
      MD5-хеш в виде строки

  - ### getContacts

    public List<Contact> getContacts()
    Возвращает список контактов, которые подписаны на рассылку
    Returns:

  - ### getContractId

    public int getContractId()
    Возвращает код договора
    Specified by:
      `getContractId` in interface `Contractable`
    Returns:
      код договора

  - ### getContractTitle

    public String getContractTitle()
    Description copied from interface: `Contractable`
    Возвращает название договора
    Specified by:
      `getContractTitle` in interface `Contractable`
    Returns:
      название договора

  - ### getDispatch

    public Dispatch getDispatch()
    Возвращает рассылку, на которую осуществлена данная подписка
    Returns:

  - ### getHumanReadableRepeatTime

    public String getHumanReadableRepeatTime()

  - ### getPreferences

    public Preferences getPreferences()
    Возвращает настройки подписки
    Returns:

  - ### getRepeatTime

    public ScheduleTime getRepeatTime()
    Возвращает расписание времени отправки для персональных рассылок
    Returns:
      null для подписок на глобальные (т.е. неперсональные) рассылки

  - ### getRepeatTimeDaysOfWeek

    public String getRepeatTimeDaysOfWeek()
    Возвращает строку дней недели персональной подписки для отображения в вебе. То есть для подписки "по понедельникам и вторникам" вернет "1,2", для подписки "каждый день" вернет "1-7"
    Returns:

  - ### getSubscriptionPeriod

    public Period getSubscriptionPeriod()
    Возвращает период действия подписки.
    Returns:
      период действия подписки.

  - ### getTotalRepeatTime

    public ScheduleTime getTotalRepeatTime()
    Возвращает итоговое расписание, по которому будут приходить сообщения рассылки. Время отправки берется из расписания рассылки, а остальные составляющие (дни недели, дни и месяцы) - из расписания самой подписки.
    Returns:

  - ### isActive

    public boolean isActive()
    Активна ли рассылка
    Returns:

  - ### isUpdate

    public boolean isUpdate()

  - ### setActive

    public Subscription setActive(boolean active)
    Устанавливает флаг активности подписки.
    Parameters:
      `active` - true - подписка активна, false - подписка не активна.

  - ### setComment

    public Subscription setComment(String comment)
    Устанавливает комментарий к подписке
    Parameters:
      `comment` -

  - ### setContacts

    public Subscription setContacts(List<Contact> contacts)
    Устанавливает список контактов, подписанных на рассылку
    Parameters:
      `contacts` -

  - ### setContractId

    public Subscription setContractId(int contractId)
    Устанавливает код договора
    Specified by:
      `setContractId` in interface `Contractable`
    Parameters:
      `contractId` - код договора

  - ### setContractTitle

    public Subscription setContractTitle(String contractTitle)
    Description copied from interface: `Contractable`
    Устанавливает название договора
    Specified by:
      `setContractTitle` in interface `Contractable`
    Parameters:
      `contractTitle` - название договора

  - ### setDispatch

    public Subscription setDispatch(Dispatch dispatch)
    Устанавливает рассылку, на которую осуществленая данная подписка
    Parameters:
      `dispatch` -

  - ### setPreferences

    public Subscription setPreferences(Preferences prefs)
    Устанавливает настройки подписки
    Parameters:
      `prefs` -

  - ### setRepeatTime

    public Subscription setRepeatTime(ScheduleTime recieveTime)
    Устанавливает расписание времени отправки для персоналных рассылок

  - ### setSubscriptionPeriod

    public Subscription setSubscriptionPeriod(Period subscriptionPeriod)
    Устанавливает период действия подписки.
    Parameters:
      `subscriptionPeriod` - период действия подписки

  - ### setUpdate

    public Subscription setUpdate(boolean update)