parameterService :: Avantys ERP Docs

Методы текстового параметра

getText(id: Int, param: Int): String?

Получение значения текстового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Строка

updateText(id: Int, param: Int, value: String?)

Обновление значения текстового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
value	новое значение (при передаче null текущее значение удалится)

Методы флагового параметра

getBoolean(id: Int, param: Int): Boolean

Получение значения флагового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Boolean (true или false)

updateBoolean(id: Int, param: Int, value: Boolean)

Обновление значения флагового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Методы числового параметра

getNumber(id: Int, paramId: Int): BigDecimal?

Получение значения числового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: BigDecimal

updateNumber(id: Int, paramId: Int, value: BigDecimal?)

Обновление значения числового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
value	объект BigDecimal - новое значение (при передаче null текущее значение удалится)

Методы tree параметра

getTree(id: Int, param: Int): MutableSet<String>

Получение значения tree параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из строк (идентификаторы)

updateTree(id: Int, param: Int, values: Set<String>)

Обновление значения tree параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	коллекция строковых идентификаторов нового значения

getTreeExt(id: Int, param: Int): MutableList<TreeTitle>

Получение значения tree параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из объектов TreeTitle (идентификаторы + текстовое значение)

Методы спискового параметра

getList(id: Int, param: Int): MutableSet<Int>

Получение значения спискового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из идентификаторов текущих значений

updateList(id: Int, param: Int, values: Set<Int>)

Обновление значения спискового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	коллекция из идентификаторов новых значений

getListExt(id: Int, param: Int): MutableSet<IdTitleComment>

Получение значения спискового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из объектов IdTitleComment текущих значений (идентификатор, название и комментарий)

updateListExt(id: Int, param: Int, values: Map<Int, String?>)

Обновление значения спискового параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	ассоциативный массив, где ключем явлется идентификатор нового значения, а значением — комментарий

Методы listCount параметра

getListCount(id: Int, param: Int): MutableSet<ParameterListCountValue>

Получение значения listCount параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из объектов ParameterListCountValue

updateListCount(id: Int, param: Int, values: Set<ParameterListCountValue>)

Обновление значения listCount параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	коллекция из объектов ParameterListCountValue

Методы email параметра

getEmail(id: Int, param: Int): MutableSet<ParameterEmailValue>

Получение значения email параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: Коллекция из объектов ParameterEmailValue

updateEmail(id: Int, param: Int, values: Set<ParameterEmailValue>)

Обновление значения email параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	коллекция из объектов ParameterEmailValue

Методы phone параметра

getPhone(id: Int, param: Int): String?

Получение значения phone параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: строка с номером телефона

updatePhone(id: Int, param: Int, format: String, value: String?)

Обновление значения phone параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
format	строка с форматом телефона
value	строка с новым номером телефона (при передачи null текущее значение удалится)

getPhoneExt(id: Int, param: Int): ParameterPhoneValue

Получение значения phone параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: объект ParameterPhoneValue

updatePhoneExt(id: Int, param: Int, phoneValue: ParameterPhoneValue)

Обновление значения phone параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
phoneValue	объект ParameterPhoneValue

Методы адресного параметра

getAddress(id: Int, param: Int, loadDetails: Boolean): MutableList<ParameterAddressValue>

Получение значения адресного параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
loadDetails	флаг загрузки всех сущностей адреса (город, улица и пр.)

Возвращаемое значение: коллекция из объектов ParameterAddressValue

updateAddress(id: Int, param: Int, values: Collection<ParameterAddressValue>)

Обновление значения адресного параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
values	коллекция объектов ParameterAddressValue

Методы date параметра

getDate(id: Int, param: Int): LocalDate?

Получение значения date параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: объект LocalDate или null если значение не установлено

updateDate(id: Int, param: Int, value: LocalDate?)

Обновление значения date параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
value	объект LocalDate с новым значением (при отправке null текущее значение удалится)

Методы datetime параметра

getDateTime(id: Int, param: Int): LocalDateTime?

Получение значения datetime параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: объект LocalDateTime или null если значение не установлено

updateDateTime(id: Int, param: Int, value: LocalDateTime?)

Обновление значения datetime параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра
value	объект LocalDateTime с новым значением (при отправке null текущее значение удалится)

Вспомогательные методы

copyParam(fromObjectId: Int, toObjectId: Int, paramId: Int)

Копирование значения параметра в другой объект

Аргументы:

fromObjectId	идентификатор объекта с которого копируется значение параметра
toObjectId	идентификатор объекта на который копируется значение параметра
paramId	идентификатор параметра

copyParams(fromObjectId: Int, fromParamId: Int, toObjectId: Int, toParamId: Int)

Копирование значения параметра в другой объект

Аргументы:

fromObjectId	идентификатор объекта с которого копируется значение параметра
fromParamId	идентификтор параметра с которого скопируется значение
toObjectId	идентификатор объекта на который копируется значение параметра
toParamId	идентификатор параметра в который скопируется значение

fun isFilled(id: Int, param: Int): Boolean

Проверка заполненности параметра

Аргументы:

id	идентификатор объекта
param	идентификатор параметра

Возвращаемое значение: true если заполнен, иначе false