Дополнение описания структуры метаданных для справочников и документов

src/bslMetadata.js

@@ -12,7 +12,7 @@ define([], function () {
                },
                "predefined":{
                   "Товар":"",
-                  "Услуга":"",                  
+                  "Услуга":""                  
                }
             },
             "СтавкиНДС":{
@@ -281,16 +281,153 @@ define([], function () {
             }
          },
          "objMethods":{
+            "Заблокирован":{
+               "name":"Заблокирован",
+               "name_en":"IsLocked",
+               "description":"Определяет, заблокирован ли элемент данным объектом.",
+               "returns":"Булево, Истина - элемент заблокирован; Ложь - в противном случае."
+            },
+            "Заблокировать":{
+               "name":"Заблокировать",
+               "name_en":"Lock",
+               "description":"Выполняет блокировку объекта от изменения другими режимами или пользователями."
+            },
             "Записать":{
                "name":"Записать",
                "name_en":"Write",
                "description":"Записывает элемент справочника в базу данных."
             },
+            "Заполнить":{
+               "name":"Заполнить",
+               "name_en":"Fill",
+               "description":"Заполняет данные элемента данными из другого объекта. Инициирует событие ОбработкаЗаполнения и вызов его процедуры-обработчика в модуле плана счетов. В ней может размещаться алгоритм, заполняющий данные элемента из переданного значения.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ДанныеЗаполнения) ",
+                     "Параметры":{
+                        "ДанныеЗаполнения":"Произвольный, Значение, на основании которого выполняется заполнение счета."
+                     }
+                  }
+               }
+            },
+            "Метаданные":{
+               "name":"Метаданные",
+               "name_en":"Metadata",               
+               "description":"Предоставляет доступ к объекту описания метаданных справочника. Другой путь получения того же значения - через свойство глобального контекста Метаданные. Например: Метаданные.Справочники.Номенклатура.",
+               "returns":"ОбъектМетаданных"               
+            },
+            "Модифицированность":{
+               "name":"Модифицированность",
+               "name_en":"Modified",               
+               "description":"Определяет, был ли изменен объект после считывания из базы данных.",
+               "returns":"Истина - объект изменен; Ложь - в противном случае."
+            },            
+            "ПолучитьСсылкуНового":{
+               "name":"ПолучитьСсылкуНового",
+               "name_en":"GetNewObjectRef",
+               "description":"Позволяет для нового (созданного и еще не записанного) объекта получить ранее установленное методом УстановитьСсылкуНового значение ссылки.",
+               "returns":"СправочникСсылка"               
+            },
+            "ПолучитьФорму":{
+               "name":"ПолучитьФорму",
+               "name_en":"GetForm",
+               "description":"Получает форму элемента справочника, на который указывает ссылка.",
+               "returns":"Форма",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(Форма, Владелец?, КлючУникальности?) : Форма",
+                     "Параметры":{
+                        "Форма":"Строка, Имя формы, как оно задано в конфигураторе, или объект описания метаданного требуемой формы.",
+                        "Владелец":"Объект, который будет являться владельцем открываемой формы.",
+                        "КлючУникальности":"В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. При поиске учитываются значения свойств открытых форм соответствующим значениям параметров метода. Если найдена открытая форма (по совпадению всех параметров), то она будет возвращена вместо новой формы."
+                     }
+                  }
+               }
+            },            
+            "ПроверитьЗаполнение":{
+               "name":"ПроверитьЗаполнение",
+               "name_en":"CheckFilling",
+               "description":"Проверяет заполнение реквизитов. Для реквизитов, у которых при конфигурировании свойство 'Проверка заполнения' установлено в значение 'Показывать ошибку' и реквизит не заполнен, будет сформировано сообщение об ошибке.",
+               "returns":"Булево, Истина - ошибок не обнаружено, Ложь - в противном случае."               
+            },
+            "Прочитать":{
+               "name":"Прочитать",
+               "name_en":"Read",
+               "description":"Считывает данные элемента справочника из базы данных."               
+            },
+            "Разблокировать":{
+               "name":"Разблокировать",
+               "name_en":"Unlock",
+               "description":"Выполняет разблокировку элемента, если он заблокирован данным объектом."               
+            },
+            "Скопировать":{
+               "name":"Скопировать",
+               "name_en":"Copy",
+               "description":"Создает новый элемент справочника копированием существующего",
+               "returns":"СправочникОбъект"
+            },
+            "Удалить":{
+               "name":"Удалить",
+               "name_en":"Delete",
+               "description":"Удаляет элемент справочника из базы данных. Важно! В отличие от метода УстановитьПометкуУдаления, данный метод производит непосредственное удаление элемента справочника без возможности восстановления и без проверки ссылочной целостности. Использовать данный метод нужно крайне осмотрительно."
+            },
+            "Уровень":{
+               "name":"Уровень",
+               "name_en":"Level",
+               "description":"Получает уровень элемента справочника.",
+               "returns":"Число, Уровень элемента справочника. "
+            },
+            "УстановитьНовыйКод":{
+               "name":"УстановитьНовыйКод",
+               "name_en":"SetNewCode",
+               "description":"Устанавливает новый код. Если в коде присутствует числовая часть, то новый код автоматически устанавливается следующим за имеющимся максимальным. При этом определяется текущий максимальный код среди элементов данного справочника. Если передан префикс, то новый код устанавливается следующим образом: выполняется поиск максимального кода среди кодов, имеющих данный префикс, новый код выбирается как следующий от найденного кода.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ПрефиксКода?)",
+                     "Параметры":{
+                        "ПрефиксКода":"Строковое значение префикса. Если префикс указан, то новый код будет формироваться с учетом префикса. "
+                     }
+                  }
+               }
+            },
+            "УстановитьПометкуУдаления":{
+               "name":"УстановитьПометкуУдаления",
+               "name_en":"SetDeletionMark",
+               "description":"Устанавливает/снимет пометку на удаление. Объект при этом не удаляется из базы данных. Окончательное удаление помеченных счетов происходит при удалении помеченных объектов.",               
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ПометкаУдаления, ВключаяПодчиненные?)",
+                     "Параметры":{
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята.",
+                        "ВключаяПодчиненные":"Булево, Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном счете и во всех подчиненных счетах. Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент."
+                     }
+                  }
+               }
+            },
+            "УстановитьСсылкуНового":{
+               "name":"УстановитьСсылкуНового",
+               "name_en":"SetNewObjectRef",
+               "description":"Устанавливает значение для нового (созданного и еще не записанного) объекта, которое будет назначено при записи в качестве ссылки. Значение не может равняться ссылке какого-либо из имеющихся в базе данных объекта данного типа. Уникальность ссылки проверяется при записи объекта.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(Ссылка)",
+                     "Параметры":{
+                        "Ссылка":" СправочникСсылка, Ссылка, которая будет назначена при записи нового объекта. "
+                     }
+                  }
+               }
+            },
+            "ЭтоНовый":{
+               "name":"ЭтоНовый",
+               "name_en":"IsNew",
+               "description":"Определяет, записан ли элемент в базу данных.",
+               "returns":"Булево, Истина - изменяется еще ни разу не записанный элемент; Ложь - элемент уже записан."
+            },
             "ПолучитьОбъект":{
                "name":"ПолучитьОбъект",
                "name_en":"GetObject",
-               "description":"Получает по ссылке объект для чтения, изменения, добавления и удаления документа.",
+               "description":"Получает по ссылке объект, предназначенный для модификации счета.",
-               "returns":"СправочникОбъект/Неопределено, Неопределено - объекта в базе нет (например, при обмене данными или после непосредственного удаления объекта, на который есть ссылки)."
+               "returns":"ПланВидовРасчетаОбъект/Неопределено, Неопределено - объекта в базе нет (например, при обмене данными или после непосредственного удаления объекта, на который есть ссылки)."
             },
             "Пустая":{
                "name":"Пустая",
@@ -298,12 +435,6 @@ define([], function () {
                "description":"Определяет, является ли ссылка пустой или нет.",
                "returns":"Булево, Истина - ссылка не указывает ни на какой объект (пустая ссылка); Ложь - в противном случае."
             },            
-            "Скопировать":{
-               "name":"Скопировать",
-               "name_en":"Copy",
-               "description":"Создает новый элемент справочника копированием существующего.",
-               "returns":"СправочникОбъект"
-            },
             "УникальныйИдентификатор":{
                "name":"УникальныйИдентификатор",
                "name_en":"UUID",
@@ -499,6 +630,17 @@ define([], function () {
             }
          },
          "objMethods":{
+            "Заблокирован":{
+               "name":"Заблокирован",
+               "name_en":"IsLocked",
+               "description":"Определяет, заблокирован ли элемент данным объектом.",
+               "returns":"Булево, Истина - элемент заблокирован; Ложь - в противном случае."
+            },
+            "Заблокировать":{
+               "name":"Заблокировать",
+               "name_en":"Lock",
+               "description":"Выполняет блокировку объекта от изменения другими режимами или пользователями."
+            },
             "Записать":{
                "name":"Записать",
                "name_en":"Write",
@@ -507,16 +649,169 @@ define([], function () {
                   "default":{
                      "СтрокаПараметров":"(РежимЗаписи?, РежимПроведения?)",
                      "Параметры":{
-                        "РежимЗаписи":"РежимЗаписиДокумента, Позволяет выбрать один из возможных режимов записи.",
+                        "РежимЗаписи":"РежимЗаписиДокумента, Позволяет выбрать один из возможных режимов записи. Значение по умолчанию: Запись.",
-                        "РежимПроведения":"РежимПроведенияДокумента, Позволяет выбрать один из возможных режимов проведения."
+                        "РежимПроведения":"РежимПроведенияДокумента. Позволяет выбрать один из возможных режимов проведения. Значение по умолчанию: Неоперативный."
                      }
                   }
                }
             },
+            "Заполнить":{
+               "name":"Заполнить",
+               "name_en":"Fill",
+               "description":"Заполняет данные элемента данными из другого объекта. Инициирует событие ОбработкаЗаполнения и вызов его процедуры-обработчика в модуле плана счетов. В ней может размещаться алгоритм, заполняющий данные элемента из переданного значения.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ДанныеЗаполнения) ",
+                     "Параметры":{
+                        "ДанныеЗаполнения":"Произвольный, Значение, на основании которого выполняется заполнение счета."
+                     }
+                  }
+               }
+            },
+            "Метаданные":{
+               "name":"Метаданные",
+               "name_en":"Metadata",               
+               "description":"Предоставляет доступ к объекту описания метаданных документа. Другой путь получения того же значения - через свойство глобального контекста Метаданные. Например: Метаданные.Документы.РасходнаяНакладная.",
+               "returns":"ОбъектМетаданных"               
+            },
+            "Модифицированность":{
+               "name":"Модифицированность",
+               "name_en":"Modified",               
+               "description":"Определяет, был ли изменен объект после считывания из базы данных.",
+               "returns":"Истина - объект изменен; Ложь - в противном случае."
+            },
+            "МоментВремени":{
+               "name":"МоментВремени",
+               "name_en":"PointInTime",               
+               "description":"Получает момент времени документа.",
+               "returns":"МоментВремени"
+            },
+            "ПолучитьМакет":{
+               "name":"ПолучитьМакет",
+               "name_en":"GetTemplate",
+               "description":"Получает макет документа.",
+               "returns":"ТабличныйДокумент; ТекстовыйДокумент; другой объект, который может быть макетом.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(Макет) : Объект",
+                     "Параметры":{
+                        "Макет":"Имя макета, как оно задано в конфигураторе, или объект описания метаданного требуемого макета"
+                     }
+                  }
+               }
+            },            
+            "ПолучитьСсылкуНового":{
+               "name":"ПолучитьСсылкуНового",
+               "name_en":"GetNewObjectRef",
+               "description":"Позволяет для нового (созданного и еще не записанного) объекта получить ранее установленное методом УстановитьСсылкуНового значение ссылки.",
+               "returns":"ДокументСсылка"               
+            },
+            "ПолучитьФорму":{
+               "name":"ПолучитьФорму",
+               "name_en":"GetForm",
+               "description":"Получает форму документа, которая содержит данный объект встроенного языка.",
+               "returns":"Форма",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(Форма, Владелец?, КлючУникальности?) : Форма",
+                     "Параметры":{
+                        "Форма":"Строка, Имя формы, как оно задано в конфигураторе, или объект описания метаданного требуемой формы.",
+                        "Владелец":"Объект, который будет являться владельцем открываемой формы.",
+                        "КлючУникальности":"В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. При поиске учитываются значения свойств открытых форм соответствующим значениям параметров метода. Если найдена открытая форма (по совпадению всех параметров), то она будет возвращена вместо новой формы."
+                     }
+                  }
+               }
+            },            
+            "ПроверитьЗаполнение":{
+               "name":"ПроверитьЗаполнение",
+               "name_en":"CheckFilling",
+               "description":"Проверяет заполнение реквизитов. Для реквизитов, у которых при конфигурировании свойство 'Проверка заполнения' установлено в значение 'Показывать ошибку' и реквизит не заполнен, будет сформировано сообщение об ошибке.",
+               "returns":"Булево, Истина - ошибок не обнаружено, Ложь - в противном случае."               
+            },
+            "Прочитать":{
+               "name":"Прочитать",
+               "name_en":"Read",
+               "description":"Считывает данные документа из базы данных."
+            },
+            "Разблокировать":{
+               "name":"Разблокировать",
+               "name_en":"Unlock",
+               "description":"Выполняет разблокировку документа, если он заблокирован этим объектом."
+            },
+            "Скопировать":{
+               "name":"Скопировать",
+               "name_en":"Copy",
+               "description":"Создает новый документ копированием существующего.",
+               "returns":"ДокументОбъект"
+            },
+            "Удалить":{
+               "name":"Удалить",
+               "name_en":"Delete",
+               "description":"Удаляет документ из базы данных. Важно! В отличие от метода УстановитьПометкуУдаления, данный метод производит непосредственное удаление документа без возможности восстановления и без проверки ссылочной целостности. Использовать данный метод нужно крайне осмотрительно."
+            },
+            "УстановитьВремя":{
+               "name":"УстановитьВремя",
+               "name_en":"SetTime",
+               "description":"Устанавливает время документа.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(РежимОпределенияВремени?, ИспользоватьЖурналы?)",
+                     "Параметры":{
+                        "РежимОпределенияВремени":"РежимАвтоВремя, Устанавливает режим автоматического определения времени при записи нового документа.",
+                        "ИспользоватьЖурналы":"Булево, Определяет, устанавливать ли время с использованием журналов, в которых отражается данный документ."
+                     }
+                  }
+               }
+            },
+            "УстановитьНовыйНомер":{
+               "name":"УстановитьНовыйНомер",
+               "name_en":"SetNewNumber",
+               "description":"Устанавливает новый номер документа для заданного префикса номера.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ПрефиксНомера?)",
+                     "Параметры":{
+                        "ПрефиксНомера":"Строка, Префикс устанавливаемого номера.Значение по умолчанию: Пустая строка."
+                     }
+                  }
+               }
+            },
+            "УстановитьПометкуУдаления":{
+               "name":"УстановитьПометкуУдаления",
+               "name_en":"SetDeletionMark",
+               "description":"Устанавливает/снимет пометку на удаление документа. Документ при этом не удаляется из базы данных. Окончательное удаление помеченных документов происходит при удалении помеченных объектов.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(ПометкаУдаления)",
+                     "Параметры":{
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята."
+                     }
+                  }
+               }
+            },
+            "УстановитьСсылкуНового":{
+               "name":"УстановитьСсылкуНового",
+               "name_en":"SetNewObjectRef",
+               "description":"Устанавливает значение для нового (созданного и еще не записанного) объекта, которое будет назначено при записи в качестве ссылки. Значение не может равняться ссылке какого-либо из имеющихся в базе данных объекта данного типа. Уникальность ссылки проверяется при записи объекта.",
+               "signature":{
+                  "default":{
+                     "СтрокаПараметров":"(Ссылка)",
+                     "Параметры":{
+                        "Ссылка":" ДокументСсылка, Ссылка, которая будет назначена при записи нового объекта. "
+                     }
+                  }
+               }
+            },
+            "ЭтоНовый":{
+               "name":"ЭтоНовый",
+               "name_en":"IsNew",
+               "description":"Определяет, записан ли документ в базу данных.",
+               "returns":"Булево, Истина - изменяется еще ни разу не записанный элемент; Ложь - элемент уже записан."
+            },
             "ПолучитьОбъект":{
                "name":"ПолучитьОбъект",
                "name_en":"GetObject",
-               "description":"Получает по ссылке объект для чтения, изменения, добавления и удаления документа.",
+               "description":"Получает по ссылке объект, предназначенный для модификации счета.",
                "returns":"ДокументОбъект/Неопределено, Неопределено - объекта в базе нет (например, при обмене данными или после непосредственного удаления объекта, на который есть ссылки)."
             },
             "Пустая":{
@@ -525,12 +820,6 @@ define([], function () {
                "description":"Определяет, является ли ссылка пустой или нет.",
                "returns":"Булево, Истина - ссылка не указывает ни на какой объект (пустая ссылка); Ложь - в противном случае."
             },            
-            "Скопировать":{
-               "name":"Скопировать",
-               "name_en":"Copy",
-               "description":"Создает новый документ копированием существующего.",
-               "returns":"ДокументОбъект"
-            },
             "УникальныйИдентификатор":{
                "name":"УникальныйИдентификатор",
                "name_en":"UUID",
@@ -2458,10 +2747,9 @@ define([], function () {
                "description":"Устанавливает/снимет пометку на удаление. Объект при этом не удаляется из базы данных. Окончательное удаление помеченных счетов происходит при удалении помеченных объектов.",               
                "signature":{
                   "default":{
-                     "СтрокаПараметров":"(ПометкаУдаления, ВключаяПодчиненные?)",
+                     "СтрокаПараметров":"(ПометкаУдаления)",
                      "Параметры":{
-                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята.",
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята."
-                        "ВключаяПодчиненные":"Булево, Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном счете и во всех подчиненных счетах. Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент."
                      }
                   }
                }
@@ -2859,10 +3147,9 @@ define([], function () {
                "description":"Устанавливает/снимет пометку на удаление. Объект при этом не удаляется из базы данных. Окончательное удаление помеченных счетов происходит при удалении помеченных объектов.",               
                "signature":{
                   "default":{
-                     "СтрокаПараметров":"(ПометкаУдаления, ВключаяПодчиненные?)",
+                     "СтрокаПараметров":"(ПометкаУдаления)",
                      "Параметры":{
-                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята.",
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята."                        
-                        "ВключаяПодчиненные":"Булево, Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном счете и во всех подчиненных счетах. Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент."
                      }
                   }
                }
@@ -3182,10 +3469,9 @@ define([], function () {
                "description":"Устанавливает/снимет пометку на удаление. Объект при этом не удаляется из базы данных. Окончательное удаление помеченных счетов происходит при удалении помеченных объектов.",               
                "signature":{
                   "default":{
-                     "СтрокаПараметров":"(ПометкаУдаления, ВключаяПодчиненные?)",
+                     "СтрокаПараметров":"(ПометкаУдаления)",
                      "Параметры":{
-                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята.",
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята."
-                        "ВключаяПодчиненные":"Булево, Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном счете и во всех подчиненных счетах. Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент."
                      }
                   }
                }
@@ -4065,10 +4351,9 @@ define([], function () {
                "description":"Устанавливает/снимет пометку на удаление. Объект при этом не удаляется из базы данных. Окончательное удаление помеченных счетов происходит при удалении помеченных объектов.",               
                "signature":{
                   "default":{
-                     "СтрокаПараметров":"(ПометкаУдаления, ВключаяПодчиненные?)",
+                     "СтрокаПараметров":"(ПометкаУдаления)",
                      "Параметры":{
-                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята.",
+                        "ПометкаУдаления":"Булево, Признак установки / снятие пометки на удаление. Истина - пометка будет установлена; Ложь - пометка будет снята."                        
-                        "ВключаяПодчиненные":"Булево, Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном счете и во всех подчиненных счетах. Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент."
                      }
                   }
                }