1. Функции, используемые в формулах отбора документов

@All

Область применения: без ограничений.

Всегда возвращает 1 (TRUE). Используется в формулах отбора документов, видимости объектов, фоновых агентах.

Пример. Отбирает все документы при использовании в формуле отбора в виде.

SELECT @All

@AllChildren в SELECT формула_отбора | @AllChildren

Область применения: разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Domino ниже R4.

Конструкция SELECT формула_отбора | @AllChildren позволяет отобрать все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами только на документы, удовлетворяющие формуле отбора.

Обратите внимание, что конструкция SELECT формула_отбора | @IsResponseDoc возвращает все документы, удовлетворяющие формуле отбора, плюс все документы из базы, которые являются документами-ответами (не важно, на какие документы).

@AllDescendants в SELECT формула_отбора | @AllDescendants

Область применения: разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Lotus Notes/Domino ниже R4.

Конструкция SELECT формула_отбора | @AllDescendants позволяет отобрать все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами и документами - ответами на ответ на всех уровнях дерева, "начинающегося" только от документов, удовлетворяющих формуле отбора.

Пример. Пусть "дерево" документов-ответов таково.

1.0 Какой твой любимый цвет? (Esteban Garcia)

1.1 Голубой (Mary Lu)

1.2 "Цвет морской волны" (Jim Thompson)

1.2.1 Почему тебе нравится "цвет морской волны"? (Mary Lu)

1.2.2 Он навевает мне мысли об океане (Jim Thompson)

1.3 А мне нравится оранжевый (Bill Jones)

Пусть приведенный здесь текст берется из поля Subject, а заключенные в скобки имена являются именами авторов документов. Тогда первый оператор SELECT отбирает документы 1.2, 1.2.1 и 1.2.2; второй - 1.0, 1.1, 1.2 и 1.3; третий - 1.0, 1.1, 1.2, 1.2.1, 1.2.2 и 1.3; а четвертый - 1.2.1 и 1.3.

SELECT @Author = "Jim Thompson" | @AllChildren

SELECT @Author = "Esteban Garcia" | @AllChildren

SELECT @Author = "Esteban Garcia" | @AllDescendants

SELECT @Contains( Subject; "нравится" ) | @AllChildren

2. Функции, используемые в формулах колонок

@DocChildren @DocChildren( строка )

@DocChildren( строка_1; строка_2 )

@DocChildren( строка_1; строка_2; строка_3 )

Область применения: разрешается использовать только в формулах колонок и заголовка окна. В Web-приложениях работает только в формулах колонок.

Функция используется для определения числа ответных документов у текущего документа или категории (считаются только документы-ответы на текущий документ, но не ответы на ответы). Возвращаемое значение, содержащее число ответов, представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число.

При вызове без параметров возвращает число ответных документов. При вызове с одним параметром строка, эта же строка и возвращается. Если в ней присутствует символ "%", он заменяется на число документов ответов.

При вызове с двумя аргументами возвращает строку_2, в случае, если число ответов больше нуля, или строку_1 при отсутствии ответных документов или категорий.

При вызове с тремя аргументами возвращает строку_3, в случае если число ответов больше одного, строку_1 при отсутствии ответных документов или категорий, и строку_2, если ответов один.

Символ "%" заменяется на число документов ответов (при вызове с двумя аргументами в строке_2, или в строке_3 при вызове с тремя аргументами).

При использовании в формуле столбца, если Вы хотите получить информацию о числе ответных документов у категории, столбец с функцией @DocChildren должен находиться левее категоризирующей колонки. При использовании в формуле полей, для получения информации о числе документов-ответов, исходный документ должен быть открыт. Поэтому при печати документа из представления, результат у функции @DocChildren будет не определен.

Пример. При использовании в формуле колонки будет возвращать одно из трех значений "Ответов нет", "Ответ есть" или "Число ответов: N".

@DocChildren( "Ответов нет" ; "Ответ есть" ; "Число ответов: %" )

@DocDescendants @DocDescendants( строка )

@DocDescendants( строка_1; строка_2 )

@DocDescendants( строка_1; строка_2; строка_3 )

Область применения: разрешается использовать только в формулах колонок и заголовка окна. В Web-приложениях работает только в формулах колонок.

Функция используется для определения числа ответных документов у текущего документа или категории (считаются документы-ответы и ответ-на-ответ у текущего документа). Возвращаемое значение, содержащее число ответов, представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число.

Параметры строка, строка_1, строка_2 и строка_3 синтаксически и семантически эквивалентны соответствующим параметрам функции @DocChildren.

Пример. При использовании в формуле колонки будет возвращать одно из двух значений "Ответов нет" или "Число ответов: N".

@DocDescendants( "Ответов нет" ; "Число ответов: %" )

@DocLevel

Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.

Возвращает значение представляющее текущий уровень документа или категории в дереве ответов. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функции в формулах полей.

При использовании в формулах заголовка окна и полей всегда возвращает значение "1" до тех пор, пока документ не будет сохранен. В формулах полей, после сохранения, значение функции @DocLevel может быть преобразовано к числу.

Пример. При использовании в формуле колонки возвращает "Уровень иерархии: N".

"Уровень иерархии: " + @DocLevel

@DocNumber

@DocNumber( строка )

@DocNumber( "" )

@DocParentNumber

@DocParentNumber( "" )

@DocParentNumber( строка )

Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.

Возвращают значения, представляющие иерархический уровень, соответственно текущего документа или категории в дереве ответов для @DocNumber, или родительского документа или категории для @DocParentNumber. Для функции @DocParentNumber текущий и родительский уровень должны быть оба одного типа, или документами, или категориями, в противном случае результат функции не определен. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функций в формулах полей. Возвращаемое значение имеет вид, например, "2.3" - это значит (для @DocNumber), что документ находится на втором уровне иерархии, и в рамках одного уровня находится на третьем месте.

При использовании @DocNumber в формулах заголовка окна и полей всегда возвращает значение "0" до тех пор, пока документ не будет сохранен. Возвращаемое значение @DocParentNumber в этом же случае вообще не определено. В формулах полей, после сохранения, значение функций @DocNumber и @DocParentNumber может быть преобразовано к числу.

При вызове функции с параметром строка, в возвращаемом значении разделитель "." между уровнями иерархии заменяется на первый символ строки. Обратите внимание, что по синтаксису строка должна состоять из одного символа.

Если в качестве параметра используется пустая строка "", то это заставляет функции в возвращаемом значении выводить только уровень иерархии внутри текущего уровня, т.е. выводится правая составляющая иерархии.

Пример. При использовании в формуле колонки возвращает "Уровень иерархии: N.M".

"Уровень иерархии: " + @DocNumber

@DocSublings

Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.

Возвращает значение представляющее количество документов или категорий на текущем уровне иерархии в дереве ответов. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функции в формулах полей.

При использовании в формулах заголовка окна и полей всегда возвращает значение "0" до тех пор, пока документ не будет сохранен. В формулах полей, после сохранения, значение функции @DocSublings может быть преобразовано к числу. При использовании в формуле полей, для получения информации о числе документов-ответов, исходный документ должен быть открыт. Поэтому при печати документа из представления результат у функции @DocSublings будет не определен.

Пример. При использовании в формуле колонки возвращает "Число документов на уровне иерархии: N".

"Число документов на уровне иерархии: " + @DocSiblings

@IsExpandable

@IsExpandable( строка )

@IsExpandable( строка_1; строка_2 )

Область применения: разрешается использовать только в формулах колонок. В Web-приложениях не работает.

Функция используется для определения, является ли данный уровень документов в виде "разворачиваемым". Если не указаны параметры, @IsExpandable возвращает односимвольную строку "+", если запись разворачиваемая, и "-" , если нет. С одним параметром возвращает строку вместо "+", если запись разворачиваемая, и ничего не возвращает в противном случае. С двумя параметрами возвращает строку_1 вместо "+" и строку_2 вместо "-".

Если Вы хотите получить информацию о "разворачиваемости" категории, то столбец с функцией @IsExpandable должен находиться левее категоризирующей колонки.

Пример 1. Возвращает "+", если документ или категория разворачиваемые, и "-", если нет.

@IsExpandable

Пример 2. Возвращает "&", если документ или категория разворачиваемые.

@IsExpandable( "&" )

Пример 3. Возвращает "Да", если документ или категория разворачиваемые, и "Нет" в противном случае.

@IsExpandable( "Да"; "Нет" )