CardSearchResponse (Set10POSAPI 0.0.0_DO_NOT_CHANGE

java.lang.Object
- ru.crystals.pos.api.plugin.card.CardSearchResponse

```
public class CardSearchResponse
extends java.lang.Object
```
Сущность, описывающая отклик на запрос информации по карте/купону.

Field Summary

Fields
Modifier and Type	Field and Description
`private CardEntity`	`card`
`private CardSearchDataForFunctionPlugin`	`cardSearchDataForFunctionalPlugin` Данные для поиска карты функциональным плагином.
`private java.util.Set<java.lang.String>`	`cardsToRemove`
`private java.util.List<java.lang.String>`	`cashierMessages`
`private java.util.List<CommunicationMessage>`	`communicationMessages` Список расширенных сообщений кассиру.
`private CardSearchResponseStatus`	`responseStatus`

Constructor Summary

Constructors
Constructor and Description
`CardSearchResponse(CardSearchResponseStatus responseStatus)` Конструктор
`CardSearchResponse(CardSearchResponseStatus responseStatus, CardEntity card)` Конструктор

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCashierMessage(java.lang.String message)` Добавляет сообщение кассиру.
`void`	`addCashierMessages(java.util.List<java.lang.String> messages)` Добавить список сообщений кассиру.
`void`	`addСashierMessage(java.lang.String cashierMessage)` Deprecated. в названии этого метода допущена синтаксическая ошибка (смешение кириллицы и латиницы), посему метод объявлен как устаревший и не рекомендуется к использованию. Используйте метод `addCashierMessage(String)` вместо него.
`void`	`addСashierMessages(java.util.List<java.lang.String> cashierMessages)` Deprecated. в названии этого метода допущена синтаксическая ошибка (смешение кириллицы и латиницы), посему метод объявлен как устаревший и не рекомендуется к использованию. Используйте метод `addCashierMessages(List)` вместо него.
`CardEntity`	`getCard()` Вернет саму карту, запрос на получение информации по которой был сделан.
`CardSearchDataForFunctionPlugin`	`getCardSearchDataForFunctionalPlugin()` Получить данные для поиска карты функциональным плагином.
`java.util.Set<java.lang.String>`	`getCardsToRemove()` Возвращает номера карт, которые должны быть удалены из чека (заменены найденной картой)
`java.util.List<java.lang.String>`	`getCashierMessages()` Список сообщений, что необходимо показать кассиру при добавлении данной карты в чек.
`java.util.List<CommunicationMessage>`	`getCommunicationMessages()` Возвращают список "расширенных" сообщений кассиру, в которых допустимо управлять иконкой, а также делить текст на смысловые блоки.
`CardSearchResponseStatus`	`getResponseStatus()` Получить статус отклика
`void`	`setCard(CardEntity card)` Установить карту, запрос на получение информации по которой был сделан.
`void`	`setCardSearchDataForFunctionalPlugin(CardSearchDataForFunctionPlugin cardSearchDataForFunctionalPlugin)` Установить данные для поиска карты функциональным плагином.
`void`	`setResponseStatus(CardSearchResponseStatus responseStatus)` Установить статус отклика
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - responseStatus
```
private CardSearchResponseStatus responseStatus
```
  - card
```
private CardEntity card
```
  - cardsToRemove
```
private java.util.Set<java.lang.String> cardsToRemove
```
  - cashierMessages
```
private java.util.List<java.lang.String> cashierMessages
```
  - communicationMessages
```
private java.util.List<CommunicationMessage> communicationMessages
```
    Список расширенных сообщений кассиру. В отличие от старых сообщений эти умеют управлять иконкой сообщения и разделяют текст на семантические блоки.
    
    Since:
    
    0.0.46
  - cardSearchDataForFunctionalPlugin
```
private CardSearchDataForFunctionPlugin cardSearchDataForFunctionalPlugin
```
    Данные для поиска карты функциональным плагином.
- Constructor Detail
  - CardSearchResponse
```
public CardSearchResponse(CardSearchResponseStatus responseStatus)
```
    Конструктор
    
    Parameters:
    
    responseStatus - статус запроса карты
    
    See Also:
    
    CardSearchResponseStatus
  - CardSearchResponse
```
public CardSearchResponse(CardSearchResponseStatus responseStatus,
                          CardEntity card)
```
    Конструктор
    
    Parameters:
    
    responseStatus - статус запроса карты
    
    card - карта
    
    See Also:
    
    CardSearchResponseStatus, CardEntity
- Method Detail
  - getResponseStatus
```
public CardSearchResponseStatus getResponseStatus()
```
    Получить статус отклика
    
    Returns:
    
    не null
    
    See Also:
    
    CardSearchResponseStatus
  - setResponseStatus
```
public void setResponseStatus(CardSearchResponseStatus responseStatus)
```
    Установить статус отклика
    
    Parameters:
    
    responseStatus - статус
    
    See Also:
    
    CardSearchResponseStatus
  - getCard
```
public CardEntity getCard()
```
    Вернет саму карту, запрос на получение информации по которой был сделан.
    
    Returns:
    
    null, если карта не найдена в справочнике карт по любой причине (т.е., если статус отклика отличен от CardSearchResponseStatus.OK)
    
    See Also:
    
    CardEntity
  - setCard
```
public void setCard(CardEntity card)
```
    Установить карту, запрос на получение информации по которой был сделан.
    
    Parameters:
    
    card - null, если карта не найдена в справочнике карт по любой причине (т.е., если статус отклика отличен от CardSearchResponseStatus.OK)
    
    See Also:
    
    CardEntity
  - getCardsToRemove
```
public java.util.Set<java.lang.String> getCardsToRemove()
```
    Возвращает номера карт, которые должны быть удалены из чека (заменены найденной картой)
    
    Returns:
    
    номера карт, которые должны быть удалены из чека
    
    Since:
    
    0.0.46
  - getCashierMessages
```
public java.util.List<java.lang.String> getCashierMessages()
```
    Список сообщений, что необходимо показать кассиру при добавлении данной карты в чек.
    Например, попросить кассира напомнить покупателю о необходимости заполнить анкету или заменить карту. Или вызвать охрану потому что карта в "черном" списке (например, украдена).
    
    Returns:
    
    допускается возвращать null либо пустой список, если никаких сообщений кассиру показывать не требуется
    
    See Also:
    
    getCommunicationMessages()
  - addСashierMessages
```
@Deprecated
public void addСashierMessages(java.util.List<java.lang.String> cashierMessages)
```
    Deprecated. в названии этого метода допущена синтаксическая ошибка (смешение кириллицы и латиницы), посему метод объявлен как устаревший и не рекомендуется к использованию. Используйте метод addCashierMessages(List) вместо него.
    
    Установить список сообщений, что необходимо показать кассиру при добавлении данной карты в чек.
    
    Parameters:
    
    cashierMessages - сообщения
    
    See Also:
    
    getCashierMessages()
  - addCashierMessages
```
public void addCashierMessages(java.util.List<java.lang.String> messages)
```
    Добавить список сообщений кассиру.
    
    Parameters:
    
    messages - список сообщений кассиру.
    
    See Also:
    
    getCashierMessages()
  - addСashierMessage
```
@Deprecated
public void addСashierMessage(java.lang.String cashierMessage)
```
    Deprecated. в названии этого метода допущена синтаксическая ошибка (смешение кириллицы и латиницы), посему метод объявлен как устаревший и не рекомендуется к использованию. Используйте метод addCashierMessage(String) вместо него.
    
    Добавляет сообщение кассиру.
    
    Parameters:
    
    cashierMessage - текст сообщения кассиру.
  - addCashierMessage
```
public void addCashierMessage(java.lang.String message)
```
    Добавляет сообщение кассиру.
    
    Parameters:
    
    message - текст сообщения кассиру.
    
    See Also:
    
    getCashierMessages()
  - getCommunicationMessages
```
public java.util.List<CommunicationMessage> getCommunicationMessages()
```
    Возвращают список "расширенных" сообщений кассиру, в которых допустимо управлять иконкой, а также делить текст на смысловые блоки. Сюда можно добавить своих сообщений кассиру.
    
    Returns:
    
    список расширенных сообщений кассиру, куда можно добавить своё сообщение, или пустой список, если таких нет.
    
    Since:
    
    0.0.46
    
    See Also:
    
    getCashierMessages()
  - getCardSearchDataForFunctionalPlugin
```
public CardSearchDataForFunctionPlugin getCardSearchDataForFunctionalPlugin()
```
    Получить данные для поиска карты функциональным плагином.
    
    Returns:
    
    данные для поиска карты функциональным плагином
  - setCardSearchDataForFunctionalPlugin
```
public void setCardSearchDataForFunctionalPlugin(CardSearchDataForFunctionPlugin cardSearchDataForFunctionalPlugin)
```
    Установить данные для поиска карты функциональным плагином.
    
    Parameters:
    
    cardSearchDataForFunctionalPlugin - данные для поиска карты функциональным плагином
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class CardSearchResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

responseStatus

card

cardsToRemove

cashierMessages

communicationMessages

cardSearchDataForFunctionalPlugin

Constructor Detail

CardSearchResponse

CardSearchResponse

Method Detail

getResponseStatus

setResponseStatus

getCard

setCard

getCardsToRemove

getCashierMessages

addСashierMessages

addCashierMessages

addСashierMessage

addCashierMessage

getCommunicationMessages

getCardSearchDataForFunctionalPlugin

setCardSearchDataForFunctionalPlugin

toString