DataStore  - AS3 ADEP Data Services

Если установлено значение true операции, изменяющие состояние под управлением DataService, подтверждаются немедленно. Если установлено значение false следует явным образом вызвать метод commit() для передачи изменений на сервер.

Значением по умолчанию является true.

При установке значения true, любые изменения коллекции подтверждаются немедленно, если свойство autoCommit имеет значение true. При установке значения false любые выполняемые в коллекции операции добавления/удаления не подтверждаются сразу.

Значением по умолчанию является true.

Если этот параметр установлен на true и свойство autoCommit имеет значение true, любое изменение значения свойства автоматически приводит к подтверждению изменения. Если установлено значение false, изменение свойства объекта значения не приводит к автоматическому вызову commit. Для передачи обновления вместо этого можно использовать явным образом метод commit() или для подтверждения изменений только в этом элементе можно вызвать метод DataManager.updateItem().

Значением по умолчанию является true.

Определяет необходимость выполнения службой подключения для требующих этого операций. Такие операции, как fill(), getItem() и count() будут пытаться установить соединение, если служба отключена, и параметр autoConnect имеет значение true. Это свойство используется для контролирования поведения непостоянно подключающихся приложений.

Интервал времени в миллисекундах для ожидания между попытками соединения с сервером, если свойство autoConnect имеет значение true.

Значением по умолчанию является 5000.

Управляет тем, как изменения, выполняемые другими клиентами, объединяются в текущем представлении данных этого клиента. Если это свойство имеет значение false, сообщения поставлены в очередь, пока приложение не вызовет метод merge() явным образом. Если это свойство имеет значение true, изменения применяются по мере поступления. Если у клиента имеются ожидающие обработки незафиксированные изменения, примененные к элементу, которые конфликтуют с объединенными изменениями, создается конфликт, который добавляется в список неразрешенных конфликтов для этого клиента. Для получения уведомлений о необходимости применения объединения можно прослушивать события изменения этого свойства.

Локальный кэш данных и изменений может быть сохранен на диск. Если autoSaveCache имеет значение true каждый раз при внесении изменения или возврате удаленного запроса эти данные будут сохраняться на диск. Если при сохранении возникнет проблема из-за переполненного диска или отказа в разрешении на запись, будет передано событие FaultEvent или возвращено Fault. Определение этого значения как false (по умолчанию) не сохраняет данные или изменения на диске. Для инициации сохранения текущих данных и изменений на локальном диске используется метод saveCache.

Связанные элементы API

Предоставляет доступ к идентификатору кэша для этой службы. Идентификатор кэша должен быть настроен до выполнения любой операции, требующей взаимодействия с данными, сохраненными на локальном диске. Если идентификатор кэша не установлен, все методы и свойства кэша считаются противоречивыми. Во время выполнения любой операции, требующей данных с локального диска, выдается ошибка DataServiceError. Это свойство предоставляет уникальный идентификатор «сеанса» для сохраненных на локальном диске данных. Это свойство должно быть определено разработчиком как уникальное значение для приложения. Значение null или пустая строка считаются неустановленным значением.

Предоставляет доступ к ChannelSet, используемому этим хранилищем DataStore. ChannelSet может быть создан и присвоен вручную, или он будет создан динамически с целью использования настроенных каналов для destinations с помощью этого DataStore. Набор channelSet должен быть одинаковым для всех объектов DataService, использующих один DataStore.

Контролирует отправку подтвержденного пакета изменений на сервер при вызове метода commit для второго пакета, в это время клиент по-прежнему ожидает ответ на ранее переданный пакет. При немедленной передаче пакета на сервер, могут возникнуть проблемы, если изменения в этом пакете зависят от изменений, внесенных сервером при подтверждении предыдущего пакета. Например, при обновлении элемента, созданного сервером в первом пакете. Если назначенный идентификатор сервера еще не получен клиентом, обновление не будет включать соответствующий идентификатор для этого элемента. Если второй пакет всегда ожидает завершения обработки первого пакета, может увеличиться время выполнения серии изменений, зависимых от времени (например, при многократном обновлении позиции курсора).

Режим по умолчанию: CQ_AUTO. Этот режим проверяет простые зависимости между любыми ожидающими обработки пакетами и следующим передаваемым пакетом. При отсутствии таковых сразу же передается новый пакет. При обнаружении обновления или удаления, зависимого от ожидающей обработки операции создания, операция обновления/удаления удерживается до завершения создания. При этом для проверки зависимостей каждое подтверждение занимает больше времени, что обычно является компромиссом между двумя другими режимами – CQ_NOWAIT и CQ_ONE_AT_A_TIME.

CQ_NOWAIT передает второй пакет сразу же без проверки зависимости. Этот режим может использоваться при назначении идентификаторов для новых объектов на стороне клиента и в целях повышения производительности накладывает выполнение пакетов друг на друга.

CQ_ONE_AT_A_TIME будет всегда ожидать завершения выполнения предыдущего пакета перед подтверждением нового пакета. Этот режим упрощает логику обработки ошибок, гарантируя, что сервер не будет получать пакет изменений. Пропущенные изменения вносятся сервером в обработку предыдущего пакета. При этом также гарантируется следующее: если ошибка происходит при обработке одного пакета, сервер не получит второй пакет до разрешения ошибок первого пакета на стороне клиента.

Значением по умолчанию является CQ_AUTO.

Указывает наличие отложенных обновлений, которые должны быть подтверждены.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Список конфликтов для всех управляемых элементов.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Определяет наличие подключения DataStore.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Текущий пакет изменений, ожидающий передачу на сервер с использованием autoCommit=false. Можно использовать это свойство для выполнения итерации через изменения, применяемые при вызове метода commit(). Пакет может быть подтвержден или отменен независимо от других пакетов. Весь набор неподтвержденных пакетов сохраняется в свойстве uncommittedBatches. Значение свойства currentBatch – всегда последний пакет в списке uncommittedBatches.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Адрес назначения для этого DataStore.

Для отключения обнаружения конфликтов во время операции обновления/повторного соединения используется флаг. В LiveCycle Data Services версии 2.6.1 обнаружение конфликтов во время обновлений не выполнялось, поэтому этот параметр может быть определен как false для восстановления поведения 2.6.1.

Значением по умолчанию является true.

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

Этот флаг определяет, будет ли приложение отправлять запрос в локальное хранилище, когда оно не подключено. Если в установках автономного адаптера определена поддержка динамического выполнения запросов, по умолчанию при вызове fill() не будет отправляться запрос в локальное хранилище, если приложение не подключено. Если для fallBackToLocalFill установлено значение true, то также отправляется запрос в локальное хранилище, если приложение не подключено.

Идентификатор этого DataStore. Это необязательное свойство используется с конфигурацией кэша для однозначной идентификации этого DataStore. Это значение не должно зависеть от сеанса, т. е. не следует создавать этот идентификатор во время выполнения с помощью метода, подобного UIDUtil.createUID(). Если это значение не определено, оно вычисляется по значениям конфигурации сервера для связанных каналов.

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

Указывает время инициализации этого DataStore и его готовность к использованию. Это свойство необходимо только при работе с настроенным во время выполнения приложением или приложением, обращающимся к кэшированным на локальном диске данным.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Указывает любые отложенные изменения, которые должны быть объединены.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Приоритет сообщения по умолчанию для сообщений, передаваемых DataStore. Допустимые значения: от 0 до 9 (0 – минимальное), -1 означает, что DataStore не имеет набора приоритетов. Обратите внимание, что, если сообщение уже имеет определенный приоритет, эта настройка является более важной.

Указывает фактическое объединение переданных на сервер изменений в клиентское представление управляемых объектов. Происходит в любое время, если autoMerge имеет значение true. Если autoMerge имеет значение false, определяется только при явном вызове метода объединения. Этот флаг позволяет определять разницу между асинхронно передаваемыми изменениями и изменениями пользователя в установленных методах.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Предоставляет доступ к тайм-ауту выполнения запроса в секундах для одной операции. Если значение меньше или равно нулю, тайм-аут запроса не применяется.

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

Значением по умолчанию является false.

Этот временной интервал можно установить для сокращения частоты сохранения кэша. Если свойство autoSaveCache имеет значение true, LiveCycle Data Services сохраняет кэш после каждого изменения. Достаточно большой объем кэша может вызвать интенсивное использование ресурсов, поэтому рекомендуется сократить частоту сохранения изменений в кэш. При установке свойства на 1000 миллисекунд кэш будет сохраняться не чаще раза в секунду.

Значением по умолчанию является 0.

Для восстановления поведения LiveCycle Data Services 2.6, заключающегося в регистрации ошибки без выдачи ошибки при измененном свойстве UID, используется значение флага false.

Значением по умолчанию является true.

Это список пакетов MessageBatches, неподтвержденных в настоящее время. Для сохранения целостности данных обычно порядок операций не должен быть изменяемым, поэтому этот список предназначен только для чтения. Посредством вызова метода createBatch() создается новый пакет. Этот метод добавляет новый пакет в конце списка uncommittedBatches и определяет currentBatch в качестве последнего элемента этого списка.

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

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Как правило, DataStore создается автоматически, но можно создать собственное хранилище DataStore и присвоить ему свойство dataStore службы DataService. Для этого следует проверить все службы передачи данных, совместно использующие один набор каналов и имеющие одинаковое значение настройки конфигурации use-transactions. Этот конструктор используется для создания DataStore с параметром адреса назначения, содержащим адрес одной из использующих это хранилище данных служб DataServices. Он применяется только для определения набора каналов. Требуется также значение флага use-transactions для этого хранилища данных.

Подтверждает отложенные изменения для коллекций и элементы, управляемые этим DataStore. Если значение свойства autoCommit равно true, транзакции не используются, и вызов этого метода не требуется. Для использования транзакций необходимо присвоить свойству autoCommit значение false и явно вызвать этот метод для подтверждения пакета изменений. Как правило, для подтверждения всех ожидающих изменений вызывается commit() без аргументов. Для подтверждения части ожидающих изменений можно предоставить дополнительные аргументы.

Перед подтверждением изменений для любого элемента в DataStore необходимо разрешить все ожидающие обработки конфликты.

Если в ассемблере use-transactions присвоено значение true, то все изменения подтверждаются атомарно. Если какая-либо операция завершается неуспешно, не применяется ни одна из операций пакета. Если use-transactions имеет значение false, то каждая операция подтверждается отдельно, и при возникновении отказа обработка прекращается. Все изменения, находящиеся в пакете до произошедшей ошибки, применяются, все изменения, находящиеся в пакете после произошедшей ошибки, не применяются. Если во время обработки пакета произошла ошибка, изменения снова помещаются в очередь неподтвержденных изменений. Для удаления вызвавших ошибку изменений необходимо вызвать revertChanges.

По умолчанию метод commit подтвердит все ожидающие изменения для всех созданных, модифицированных и удаленных элементов этого DataStore. Если требуется подтвердить только часть этих изменений, можно указать комбинацию управляемых экземпляров ArrayCollection и/или управляемых элементов, определяющую подмножество изменений, которые следует включить в пакет. Для каждой указанной коллекции массивов подтверждаются любые изменения, внесенные или в членство или в порядок элементов в этой коллекции массивов, а также в элементы этой коллекции массивов. Можно также указать список отдельных управляемых элементов, что позволит подтвердить изменения только для этих элементов. Если в параметре itemsOrCollections указать какие-либо объекты, не являющиеся управляемыми коллекциями или элементами, то возникнет ошибка DataServiceError.

Если используется параметр itemsOrCollections, и у элементов имеются свойства связи, ссылающиеся на другие элементы, то можно использовать параметр cascadeCommit для проверки включения в пакет изменений, вносимых в связанные элементы. Например, если указывается элемент группы в параметре элементов, и экземпляр группы имеет свойство members, которое ссылается на список экземпляров лица при значении true для cascadeCommit, то изменения для любого экземпляра лица также будут включены в набор подтверждаемых изменений. Если cascadeCommit имеет значение false, то будут включены изменения только для группы. Для гарантированного включения в пакет любых зависимых изменений следует использовать cascadeCommit=true.

Параметры

Указывает наличие обновлений для определенного объекта, которые ожидают подтверждения.

Параметры

Вызывает попытку установления этой службой соединения с удаленным адресатом. Этот метод может использоваться совместно со свойством autoConnect и методом disconnect() для управления состоянием соединения.

Для изменений этой операции создает новый MessageBatch и помещает его в список uncommittedBatches. Если itemsOrCollection=null, весь набор сообщений в currentBatch помещается в новый пакет, а новый пакет создается как currentBatch. Этот метод вызывается при необходимости разделения ряда изменений и выделения блока, который может быть подтвержден или отменен как одна единица. Например, при создании вышестоящего объекта и нижестоящего элемента, связанного с этим вышестоящим, для объединения этих изменений в группу можно вызвать метод createBatch(). Выполнение этих действий дважды приведет к появлению двух пакетов, создающих по одному вышестоящему и одному нижестоящему элементу. Затем можно по отдельности подтвердить каждую группу изменений и выполнять их в порядке создания пакетов. Можно также отменить последний пакет и оставить первый пакет неизмененным. Таким способом через вызов после каждой операции createBatch(null) может быть реализована простая многоуровневая система отмены.

С помощью свойства MessageBatch.properties пакет можно отметить рядом определяемых пользователем свойств (или аргументом свойств для этого метода). Эта информация сохраняется и восстанавливается с пакетом посредством автономной функции и может использоваться для идентификации пакета на стороне клиента. Помещаемые здесь значения должны иметь возможность сериализации (т. е. должны быть объектами или классами с [RemoteClass]).

При вводе значения для параметра itemsOrCollection создается новый пакет, содержащий изменения только для элемента или коллекции элементов. Если cascadeCommit имеет значение true, любые изменения для соответствующих элементов также включаются в набор сообщений, выделяемый в новый пакет.

Параметры

Инициирует отключение всех служб передачи данных, использующих это хранилище данных.

Этот метод заполняет указанный ListCollectionView всеми идентификаторами кэша, ранее использованными в приложении.

Параметры

Инициализирует DataStore посредством инициализации метаданных всех вложенных экземпляров ConcreteDataService. При успешном завершении или сбое инициализации выполняется соответствующий обратный вызов. Если хранилище данных уже инициализировано, немедленно отправляется обратный вызов, извещающий об успешной операции. Обратные вызовы должны быть функциями без параметров.

Параметры

Регистрация пользователя из текущего адреса назначения. Вызов этого метода инициирует выход из системы всех соответствующих экземпляров DataService.

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

Повторная отправка всех данных, управляемых на стороне клиента.

Удаление всех данных, управляемых на стороне клиента. При этом освобождается кэш элементов и запросов на стороне клиента для всех данных, а также отменяется подписка на любую автоматическую синхронизацию данных с сервером.

Параметры

Отменяет все отложенные (неподтвержденные) изменения для всех служб DataServices, управляемых этим хранилищем DataStore.

Отменяет все отложенные (неподтвержденные) изменения для любых элементов в указанной управляемой коллекции.

Параметры

Определение учетных данных этого адреса назначения DataStore.

Параметры

Определение учетных данных для третьей стороны адреса назначения этого DataStore.

Параметры

Передается при обнаружении конфликта между отложенными изменениями на стороне этого клиента и изменениями, переданными другим клиентом, или между подтвержденными результатом этого клиента изменениями при обнаружении ошибки в результате конфликта в удаленном адресе назначения. DataStore передает события конфликта по всем адресам назначения, совместно использующим DataStore; кроме того, в DataService можно прослушивать события конфликта определенного типа. DataStore используется для объекта с ассоциациями, как в этом случае. Для поддержания целостности этих ассоциаций может потребоваться разрешение конфликтов в определенном порядке.

Свойства объекта события имеют следующие значения:

Событие FaultEvent.FAULT передается при возврате ошибки в результате вызова commit.

Свойства объекта события имеют следующие значения:

Событие ResultEvent.RESULT передается при успешном вызове commit.

Свойства объекта события имеют следующие значения:

Определяет необходимость проверки простых зависимостей между любыми ожидающими обработки пакетами и следующим подтверждаемым пакетом.

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

Определяет период ожидания до завершения обработки предыдущего пакета перед подтверждением нового пакета.