Package ru.bitel.bgbilling.kernel.contract.search.common

Interface ContractSearchable

public interface ContractSearchable

Описание для пользовательской реализации поиска договоров

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLOR
static final String	COLOR_BLUE
static final String	COLOR_GREEN
static final String	COLOR_RED
static final String	COMMENT
static final String	CONTRACT_BALANCE
static final String	CONTRACT_COMMENT
static final String	CONTRACT_ID
static final String	CONTRACT_TITLE
static final String	LIST_GRID
static final String	LIST_LAYOUT
static final String	TITLES
static final String	WIDTH

Method Summary

Modifier and Type	Method	Description
boolean	check(String searchData)	Реализация проверки указанных данных под условия данного поиска.
String	getTitle()	Возвращает текстовое описание данного поиска.
org.json.JSONObject	metadata()	Возможность указать читабельные названия для полей в результате поиска, так же задать иную информацию для корректного отображения результата.
List<org.json.JSONObject>	search(String searchData, int moduleId, ContractSearchableFilters filters, jakarta.xml.ws.Holder<Page> pageHolder)	Непосредтсвенная реализация выгрузки

Field Details

COLOR_RED

static final String COLOR_RED

See Also:

• Constant Field Values

COLOR_BLUE

static final String COLOR_BLUE

See Also:

• Constant Field Values

COLOR_GREEN

static final String COLOR_GREEN

See Also:

• Constant Field Values

CONTRACT_ID

static final String CONTRACT_ID

See Also:

• Constant Field Values

CONTRACT_TITLE

static final String CONTRACT_TITLE

See Also:

• Constant Field Values

CONTRACT_COMMENT

static final String CONTRACT_COMMENT

See Also:

• Constant Field Values

CONTRACT_BALANCE

static final String CONTRACT_BALANCE

See Also:

• Constant Field Values

COMMENT

static final String COMMENT

See Also:

• Constant Field Values

COLOR

static final String COLOR

See Also:

• Constant Field Values

WIDTH

static final String WIDTH

See Also:

• Constant Field Values

TITLES

static final String TITLES

See Also:

• Constant Field Values

LIST_LAYOUT

static final String LIST_LAYOUT

See Also:

• Constant Field Values

LIST_GRID

static final String LIST_GRID

See Also:

• Constant Field Values

Method Details

check

boolean check(String searchData)

Реализация проверки указанных данных под условия данного поиска. Т.е. если в searchData находятся буквенные символы, а класс предусматривает реализацию поиска, например по ИНН, то данный метод вернёт false

Parameters:

searchData - указанные данные для поиска

Returns:

true - если подходит под условие

search

List<org.json.JSONObject> search(String searchData,
 int moduleId,
 ContractSearchableFilters filters,
 jakarta.xml.ws.Holder<Page> pageHolder)
                          throws Exception

Непосредтсвенная реализация выгрузки

Parameters:

searchData - - поисковой запрос

moduleId - - id модуля для которого выбран поиск. 0, если ядро

filters - - набор фильтров выбранных в клиенте для поиска

pageHolder - - данные для построничного просмотра результатов

Returns:

возвращает список JSON-объектов по которому будет строиться итоговая таблица результата

Throws:

Exception

metadata

org.json.JSONObject metadata()

Возможность указать читабельные названия для полей в результате поиска, так же задать иную информацию для корректного отображения результата. Каждое поле указывается отдельным JSONObject и помещается в результирующий JSONObject под ключом ContractSearchable.TITLES Ключ для названия должен совпадать с ключом в списке возвращаемом методом search() Т.е. если search возвращает {contractTitle:title}, то metadata должен содержать JSONArray под ключом ContractSearchable.TITLES, в котором список JSONObject {contractTitle:Название договора}

Returns:

getTitle

String getTitle()

Возвращает текстовое описание данного поиска. Например, "Поиск по IP-адресу"

Returns: