Документация по опциям поиска

Author: nixel2007

README.md

@@ -574,6 +574,7 @@
   * все публичные непомеченные как "нестабильные" (`@unstable`) или "для служебного использования" (`@internal`) методы классов:
     * [`МенеджерСущностей`](src/Классы/МенеджерСущностей.os),
     * [`ХранилищеСущностей`](src/Классы/ХранилищеСущностей.os),
+    * [`ОпцииПоиска`](src/Классы/ОпцииПоиска.os),
     * [`МодельДанных`](src/Классы/МодельДанных.os),
     * [`ОбъектМодели`](src/Классы/ОбъектМодели.os),
     * [`ЭлементОтбора`](src/Классы/ЭлементОтбора.os);
@@ -589,6 +590,7 @@
   * все публичные непомеченные как "нестабильные" (`@unstable`) методы классов:
     * [`МодельДанных`](src/Классы/МодельДанных.os),
     * [`ОбъектМодели`](src/Классы/ОбъектМодели.os),
+    * [`ОпцииПоиска`](src/Классы/ОпцииПоиска.os),
     * [`ЭлементОтбора`](src/Классы/ЭлементОтбора.os);
     * [`ЭлементПорядка`](src/Классы/ЭлементПорядка.os);
   * значения модулей-перечислений:

docs/README.md

@@ -4,6 +4,7 @@
 
 * [МенеджерСущностей](МенеджерСущностей.md)
 * [ХранилищеСущностей](ХранилищеСущностей.md)
+* [ОпцииПоиска](ОпцииПоиска.md)
 * [АбстрактныйКоннектор](АбстрактныйКоннектор.md)
 * [КоннекторSQLite](КоннекторSQLite.md)
 * [КоннекторJSON](КоннекторJSON.md)

docs/ОпцииПоиска.md

@@ -0,0 +1,62 @@
+## ОпцииПоиска
+
+### ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+### Отборы
+
+```bsl
+// Получить список отборов для выполнения поиска.
+//
+// Возвращаемое значение:
+//   ФиксированныйМассив из ЭлементОтбора
+//
+Функция Отборы() 
+```
+
+### Отбор
+
+```bsl
+// Добавить отбор для выполнения поиска.
+//
+// Параметры:
+//   Поле - Строка - Имя поля для отбора.
+//   ВидСравнения - ВидСравнения - Вид сравнения.
+//   Значение - Произвольный - Значение для сравнения.
+//
+// Возвращаемое значение:
+//   ОпцииПоиска - Текущий объект.
+//
+Функция Отбор(Поле, ВидСравнения, Значение) 
+```
+
+### Сортировки
+
+```bsl
+// Получить список сортировок для выполнения поиска.
+//
+// Возвращаемое значение:
+//   ФиксированныйМассив из ЭлементПорядка
+//
+Функция Сортировки() 
+```
+
+### СортироватьПо
+
+```bsl
+// Добавить сортировку для выполнения поиска.
+//
+// Параметры:
+//   ИмяПоля - Строка - Имя поля для сортировки.
+//   НаправлениеСортировки - НаправлениеСортировки - Направление сортировки.
+//
+// Возвращаемое значение:
+//   ОпцииПоиска - Текущий объект.
+//
+Функция СортироватьПо(ИмяПоля, НаправлениеСортировки = Неопределено) 
+```
+

src/Классы/ОпцииПоиска.os

@@ -1,10 +1,25 @@
 Перем Отборы;
 Перем Сортировки;
 
+// Получить список отборов для выполнения поиска.
+//
+// Возвращаемое значение:
+//   ФиксированныйМассив из ЭлементОтбора
+//
 Функция Отборы() Экспорт
 	Возврат Новый ФиксированныйМассив(Отборы);
 КонецФункции
 
+// Добавить отбор для выполнения поиска.
+//
+// Параметры:
+//   Поле - Строка - Имя поля для отбора.
+//   ВидСравнения - ВидСравнения - Вид сравнения.
+//   Значение - Произвольный - Значение для сравнения.
+//
+// Возвращаемое значение:
+//   ОпцииПоиска - Текущий объект.
+//
 Функция Отбор(Поле, ВидСравнения, Значение) Экспорт
 
 	ЭлементОтбора = Новый ЭлементОтбора(Поле, ВидСравнения, Значение);
@@ -14,10 +29,24 @@
 
 КонецФункции
 
+// Получить список сортировок для выполнения поиска.
+//
+// Возвращаемое значение:
+//   ФиксированныйМассив из ЭлементПорядка
+//
 Функция Сортировки() Экспорт
 	Возврат Новый ФиксированныйМассив(Сортировки);
 КонецФункции
 
+// Добавить сортировку для выполнения поиска.
+//
+// Параметры:
+//   ИмяПоля - Строка - Имя поля для сортировки.
+//   НаправлениеСортировки - НаправлениеСортировки - Направление сортировки.
+//
+// Возвращаемое значение:
+//   ОпцииПоиска - Текущий объект.
+//
 Функция СортироватьПо(ИмяПоля, НаправлениеСортировки = Неопределено) Экспорт
 
 	ЭлементПорядка = Новый ЭлементПорядка(ИмяПоля, НаправлениеСортировки);