Для изменения размера нажмите или перетащите

DocumentNumberDirector - класс

Объект, управляющий взаимодействием с номерами карточек, с реализацией для типового решения.
Иерархия наследования

Пространство имён:  Tessa.Extensions.Default.Shared.Numbers
Сборка:  Tessa.Extensions.Default.Shared (в Tessa.Extensions.Default.Shared.dll) Версия: 3.5.0.19
Синтаксис
public class DocumentNumberDirector : NumberDirector

Тип DocumentNumberDirector предоставляет следующие члены.

Конструкторы
  ИмяОписание
Открытый методDocumentNumberDirector
Создаёт экземпляр класса с указанием его зависимостей.
В начало страницы
Свойства
  ИмяОписание
Открытое свойствоAvailableEventTypes
Доступные типы событий, происходящие с номерами. Изменение этой коллекции позволяет отключить обработку некоторых событий для всех карточек, к которым применим текущий объект.
(Унаследован от NumberDirectorBase.)
Открытое свойствоDependencies
Объект, содержащий внешние зависимости API номеров.
(Унаследован от NumberBuilder.)
Открытое свойствоIsSealed
Признак того, что объект был защищён от изменений.
(Унаследован от NumberDirectorBase.)
Защищённое свойствоPrimaryLocation (Переопределяет NumberDirectorPrimaryLocation.)
Защищённое свойствоPrimaryTypeLocation
Местоположение номера, всегда соответствующее типу Primary для текущего объекта.
(Унаследован от NumberBuilder.)
Защищённое свойствоSecondaryLocation (Переопределяет NumberDirectorSecondaryLocation.)
Защищённое свойствоSecondaryTypeLocation
Местоположение номера, всегда соответствующее типу Secondary для текущего объекта.
(Унаследован от NumberBuilder.)
Открытое свойствоTypesCache
Кэш типов карточек и документов, включённых в типовое решение.
Защищённое свойствоUnavailableCardTypes
Идентификаторы типов карточек, система нумерации для которых принудительно отключена.
(Унаследован от NumberDirectorBase.)
В начало страницы
Методы
  ИмяОписание
Защищённый методBeforeClosingTabAsync (Переопределяет NumberDirectorBeforeClosingTabAsync(INumberContext, CancellationToken).)
Защищённый методBeforeCreatingCardAsync
Предикат, проверяющий предусловия и заполняющий контекст перед обработкой события [NumberEventTypes.CreatingCard].
(Унаследован от NumberDirector.)
Защищённый методBeforeDeletingBackupCardAsync (Переопределяет NumberDirectorBeforeDeletingBackupCardAsync(INumberContext, CancellationToken).)
Защищённый методBeforeDeletingCardWithoutBackupAsync (Переопределяет NumberDirectorBeforeDeletingCardWithoutBackupAsync(INumberContext, CancellationToken).)
Защищённый методBeforeDeregisteringCardAsync
Предикат, проверяющий предусловия и заполняющий контекст перед обработкой события [NumberEventTypes.DeregisteringCard].
(Унаследован от NumberDirector.)
Защищённый методBeforeGettingDigestAsync (Переопределяет NumberDirectorBeforeGettingDigestAsync(INumberContext, CancellationToken).)
Защищённый методBeforeImportingCardAsync (Переопределяет NumberDirectorBeforeImportingCardAsync(INumberContext, CancellationToken).)
Защищённый методBeforePreparingTemplateAsync
Предикат, проверяющий предусловия и заполняющий контекст перед обработкой события [NumberEventTypes.PreparingTemplate].
(Унаследован от NumberDirector.)
Защищённый методBeforeRegisteringCardAsync
Предикат, проверяющий предусловия и заполняющий контекст перед обработкой события [NumberEventTypes.RegisteringCard].
(Унаследован от NumberDirector.)
Защищённый методBeforeReleasingNumberFromControlAsync (Переопределяет NumberDirectorBeforeReleasingNumberFromControlAsync(INumberContext, CancellationToken).)
Защищённый методBeforeReservingNumberFromControlAsync (Переопределяет NumberDirectorBeforeReservingNumberFromControlAsync(INumberContext, CancellationToken).)
Защищённый методBeforeSavingNewCardAsync
Предикат, проверяющий предусловия и заполняющий контекст перед обработкой события [NumberEventTypes.SavingNewCard].
(Унаследован от NumberDirector.)
Защищённый методCardSectionsCanBeNotLoaded
Признак того, что секции карточки, возможно, не загружены. Такая ситуация возникает, в основном, при повторных сохранениях карточек или при удалении карточек без возможности восстановления.
Открытый методCreateEmptyNumberAsync
Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder.)
Защищённый методCreateEmptyNumberCoreAsync
Создаёт объект, описывающий пустой номер заданного типа. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder.)
Открытый методCreateNumberAsync
Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder.)
Защищённый методCreateNumberCoreAsync
Создаёт объект, описывающий номер с заданными параметрами. Номер может быть пустым или не пустым в зависимости от параметров. Возвращённое значение не может быть равно null.
(Унаследован от NumberBuilder.)
Открытый методEquals
Determines whether the specified object is equal to the current object.
(Унаследован от Object.)
Защищённый методFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object.)
Защищённый методFormatNumberAsync
Форматирует текстовое представление номера по заданной строке форматирования.
(Унаследован от NumberBuilder.)
Защищённый методFormatSequenceNameAsync (Переопределяет NumberBuilderFormatSequenceNameAsync(INumberContext, NumberTypeDescriptor, String, CancellationToken).)
Открытый методGetAsyncT
Возвращает типизированные данные для контекста события, происходящего с номером.
(Унаследован от NumberBuilder.)
Открытый методGetBuilder
Возвращает объект, осуществляющий низкоуровневые действия с номерами, которые зависят от бизнес-логики. Не возвращает null.
(Унаследован от NumberDirectorBase.)
Защищённый методGetBuilderCore
Возвращает объект, осуществляющий низкоуровневые действия с номерами, которые зависят от бизнес-логики. Не возвращает null.
(Унаследован от NumberDirectorBase.)
Открытый методGetCoreAsyncT (Переопределяет NumberBuilderGetCoreAsyncT(INumberContext, Object, CancellationToken).)
Открытый методGetDigestAsync
Возвращает Digest карточки по её номерам.
(Унаследован от NumberDirector.)
Открытый методGetFullNumberAsync
Возвращает текстовое представление номера по числовому представлению для заданного действия с номером.
(Унаследован от NumberBuilder.)
Защищённый методGetFullNumberCoreAsync (Переопределяет NumberBuilderGetFullNumberCoreAsync(INumberContext, NumberTypeDescriptor, Int64, CancellationToken).)
Открытый методGetHashCode
Serves as the default hash function.
(Унаследован от Object.)
Открытый методGetNumberAsync
Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
(Унаследован от NumberBuilder.)
Защищённый методGetNumberCoreAsync
Возвращает номер, расположенный в заданных местоположении и контексте или пустой номер, если он не был найден. Метод не возвращает null.
(Унаследован от NumberBuilder.)
Защищённый методGetNumberFromCardLocationAsync
Возвращает номер, расположенный в карточке в месте, указанном в параметре cardLocation, или пустой номер, если номер пуст или его не удалось получить. Метод не возвращает null.
(Унаследован от NumberBuilder.)
Защищённый методGetPlaceholderDateTimeUtc (Переопределяет NumberBuilderGetPlaceholderDateTimeUtc(String, INumberContext, NumberTypeDescriptor, String, NullableInt64).)
Защищённый методGetPlaceholderInfoAsync
Создаёт или возвращает объект с дополнительной информацией, необходимой при обращении к API плейсхолдеров. Созданный объект кэшируется в контексте context, чтобы для той же операции он мог повторно использоваться. Например, если в операции форматируются и имя последовательности, и строковое представление номера, то обе операции по форматированию получат один и тот же объект с дополнительной информацией.
(Унаследован от NumberBuilder.)
Открытый методGetType
Gets the Type of the current instance.
(Унаследован от Object.)
Открытый методIsAvailableAsync
Выполняет проверку доступности для типа события, происходящего с номером.
(Унаследован от NumberDirectorBase.)
Защищённый методIsAvailableCoreAsync (Переопределяет NumberDirectorBaseIsAvailableCoreAsync(INumberContext, NumberEventType, CancellationToken).)
Защищённый методIsUsingNumberSystemAsync
Возвращает признак того, что для карточки разрешено использование номеров.
Защищённый методMemberwiseClone
Creates a shallow copy of the current Object.
(Унаследован от Object.)
Защищённый методMethodReturnedNull
Создаёт и возвращает исключение, которое вызывается в случае, когда перегруженный виртуальный метод вернул null, хотя он не должен был возвращать null.
(Унаследован от NumberExtendable.)
Открытый методNotifyAfterEventAsync
Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable.)
Защищённый методNotifyAfterEventCoreAsync
Выполняет постобработку события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberDirectorBase.)
Открытый методNotifyBeforeEventAsync
Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable.)
Защищённый методNotifyBeforeEventCoreAsync
Выполняет предварительную обработку события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberDirectorBase.)
Открытый методNotifyOnClosingTabAsync
Уведомляет о том, что на стороне клиента закрывается вкладка с карточкой. При этом может потребоваться освободить номер, если он был зарезервирован и ещё не был занят.
(Унаследован от NumberDirector.)
Открытый методNotifyOnCreatingCardAsync
Уведомляет о том, что выполняется создание карточки (обычным способом или по шаблону). При этом может потребоваться зарезервировать номер. Обычно выполняется на этапе AfterRequest после создания карточки.
(Унаследован от NumberDirector.)
Открытый методNotifyOnDeletingBackupCardAsync
Уведомляет о том, что карточка окончательно удаляется, т.е. удаляется её удалённая карточка [Tessa.Cards.CardHelper.DeletedTypeName]. При этом может потребоваться освободить занятый номер. Обычно выполняется на этапе BeforeCommitTransaction при удалении удалённой карточки.
(Унаследован от NumberDirector.)
Открытый методNotifyOnDeletingCardWithoutBackupAsync
Уведомляет о том, что карточка удаляется без возможности восстановления. При этом может потребоваться освободить занятый номер. Обычно выполняется на этапе BeforeCommitTransaction при удалении карточки без возможности восстановления.
(Унаследован от NumberDirector.)
Открытый методNotifyOnDeregisteringCardAsync
Уведомляет о том, что выполняется дерегистрация карточки. При этом может потребоваться освободить регистрационный номер. Обычно выполняется на этапе BeforeRequest перед сохранением карточки.
(Унаследован от NumberDirector.)
Открытый методNotifyOnEventAsync
Выполняет заданное действие с номером.
(Унаследован от NumberDirectorBase.)
Защищённый методNotifyOnEventCoreAsync
Выполняет заданное действие с номером.
(Унаследован от NumberDirectorBase.)
Открытый методNotifyOnImportingCardAsync
Уведомляет о том, что карточка импортируется. При этом может потребоваться занять номер, который был ранее занят. Обычно выполняется на этапе BeforeCommitTransaction в транзакции на сохранение карточки.
(Унаследован от NumberDirector.)
Открытый методNotifyOnPreparingTemplateAsync
Уведомляет о том, что карточка шаблона подготавливается к созданию по шаблону. При этом может потребоваться очистить поля номеров, заданных в шаблоне. Обычно выполняется на сервере на этапе AfterRequest после создания карточки, но перед событием [Tessa.Cards.Numbers.NumberEventTypes.CreatingCard].
(Унаследован от NumberDirector.)
Открытый методNotifyOnRegisteringCardAsync
Уведомляет о том, что выполняется регистрация карточки. При этом может потребоваться выделить регистрационный номер. Обычно выполняется на этапе BeforeRequest перед сохранением карточки.
(Унаследован от NumberDirector.)
Открытый методNotifyOnReleasingNumberFromControlAsync
Уведомляет о том, что выполняется освобождение номера из элемента управления.
(Унаследован от NumberDirector.)
Открытый методNotifyOnReservingNumberFromControlAsync
Уведомляет о том, что выполняется резервирование номера из элемента управления.
(Унаследован от NumberDirector.)
Открытый методNotifyOnSavingNewCardAsync
Уведомляет о том, что карточка впервые сохраняется. При этом может потребоваться выделить номер. Обычно выполняется на этапе BeforeRequest перед сохранением карточки.
(Унаследован от NumberDirector.)
Защищённый методOnClosingTabAsync (Переопределяет NumberDirectorOnClosingTabAsync(INumberContext, CancellationToken).)
Защищённый методOnCreatingCardAsync (Переопределяет NumberDirectorOnCreatingCardAsync(INumberContext, CancellationToken).)
Защищённый методOnDeletingBackupCardAsync (Переопределяет NumberDirectorOnDeletingBackupCardAsync(INumberContext, CancellationToken).)
Защищённый методOnDeletingCardWithoutBackupAsync (Переопределяет NumberDirectorOnDeletingCardWithoutBackupAsync(INumberContext, CancellationToken).)
Защищённый методOnDeregisteringCardAsync (Переопределяет NumberDirectorOnDeregisteringCardAsync(INumberContext, CancellationToken).)
Защищённый методOnGettingDigestAsync (Переопределяет NumberDirectorOnGettingDigestAsync(INumberContext, CancellationToken).)
Защищённый методOnImportingCardAsync (Переопределяет NumberDirectorOnImportingCardAsync(INumberContext, CancellationToken).)
Защищённый методOnPreparingTemplateAsync (Переопределяет NumberDirectorOnPreparingTemplateAsync(INumberContext, CancellationToken).)
Защищённый методOnRegisteringCardAsync (Переопределяет NumberDirectorOnRegisteringCardAsync(INumberContext, CancellationToken).)
Защищённый методOnReleasingNumberFromControlAsync (Переопределяет NumberDirectorOnReleasingNumberFromControlAsync(INumberContext, CancellationToken).)
Защищённый методOnReservingNumberFromControlAsync (Переопределяет NumberDirectorOnReservingNumberFromControlAsync(INumberContext, CancellationToken).)
Защищённый методOnSavingNewCardAsync (Переопределяет NumberDirectorOnSavingNewCardAsync(INumberContext, CancellationToken).)
Защищённый методProcessControlRequestAsync
Выполняет обработку запроса к API номеров на сервере, который связан с элементом управления.
(Унаследован от NumberDirector.)
Открытый методRemoveNumberQueueAsync
Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
(Унаследован от NumberBuilder.)
Защищённый методRemoveNumberQueueCoreAsync
Удаляет очередь действий с номерами для заданного контекста. Возвращает признак того, что очередь была найдена и удалена. Возвращает false, если очередь не была найдена.
(Унаследован от NumberBuilder.)
Защищённый методReplacePlaceholder
Заменяет плейсхолдеры в строке для форматирования номера или имени последовательности и возвращает строку, содержащую заменённый плейсхолдер или null, если плейсхолдер заменить не удалось. Неизвестные плейсхолдеры не изменяются в результирующей строке номера.
(Унаследован от NumberBuilder.)
Открытый методSeal
Защищает объект от изменений.
(Унаследован от NumberDirectorBase.)
Защищённый методSealInternal

Защищает объект от изменений.

Метод может быть переопределён в классах-наследниках.

(Унаследован от NumberDirectorBase.)
Открытый методStoreNumberAsync(INumberContext, INumberObject, NumberStoreMode, CancellationToken)
Сохраняет объект с номером в контексте и по местоположению, определяемому его типом.
(Унаследован от NumberBuilder.)
Открытый методStoreNumberAsync(INumberContext, INumberObject, INumberLocation, NumberStoreMode, CancellationToken)
Сохраняет объект с номером в заданном местоположении и контексте.
(Унаследован от NumberBuilder.)
Защищённый методStoreNumberCoreAsync (Переопределяет NumberBuilderStoreNumberCoreAsync(INumberContext, INumberObject, INumberLocation, NumberStoreMode, CancellationToken).)
Защищённый методStoreNumberToCardLocation
Сохраняет номер в карточку в место, указанное в параметре cardLocation. Возвращает false, если сохранить номер не удалось.
(Унаследован от NumberBuilder.)
Открытый методToString
Returns a string that represents the current object.
(Унаследован от Object.)
Защищённый методTryCreateControlRequestAsync
Создаёт и возвращает объект запроса к API номеров на сервере, который связан с элементом управления. Возвращает null, если запрос не должен быть выполнен.
(Унаследован от NumberDirector.)
Защищённый методTryGetControlResponseAsync
Возвращает объект ответа на запрос к элементу управления по ответу на запрос к API номеров на сервере. Возвращает null, если объект отсутствует в ответе на запрос.
(Унаследован от NumberDirector.)
Открытый методTryGetNumberEffectiveLocationAsync
Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
(Унаследован от NumberBuilder.)
Защищённый методTryGetNumberEffectiveLocationCoreAsync
Возвращает эффективное местоположение номера по его заданному местоположению или null, если эффективное местоположение недоступно и следует использовать заданное местоположение location. Например, местоположение [Tessa.Cards.Numbers.NumberLocationTypes.Primary] может соответствовать определённым полям в карточке, задаваемым эффективным местоположением типа [Tessa.Cards.Numbers.CardNumberLocation].
(Унаследован от NumberDirector.)
Открытый методTryGetNumberLocationAsync
Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
(Унаследован от NumberBuilder.)
Защищённый методTryGetNumberLocationCoreAsync
Возвращает местоположение номера для заданного типа или null, если местоположение не определено и действие с номером следует отменить.
(Унаследован от NumberBuilder.)
Открытый методTryGetNumberQueueAsync
Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
(Унаследован от NumberBuilder.)
Защищённый методTryGetNumberQueueCoreAsync
Возвращает очередь действий с номерами для заданного контекста или null, если очередь недоступна.
(Унаследован от NumberBuilder.)
Открытый методTryGetSequenceNameAsync
Возвращает имя последовательности, подходящее для заданного события, происходящего с номером, или null, если последовательность недоступна и операция будет считаться невыполненной.
(Унаследован от NumberBuilder.)
Защищённый методTryGetSequenceNameCoreAsync (Переопределяет NumberBuilderTryGetSequenceNameCoreAsync(INumberContext, NumberTypeDescriptor, CancellationToken).)
В начало страницы
События
  ИмяОписание
Открытое событиеAfterEvent
Событие, выполняемое в процессе постобработки события, происходящего с номером. Это предоставляет возможность изменить результат обработанного события или сохранить результат во внешнем хранилище.
(Унаследован от NumberExtendable.)
Открытое событиеBeforeEvent
Событие, выполняемое в процессе предварительной обработки события, происходящего с номером. Это предоставляет возможность полностью заместить или отменить стандартную обработку.
(Унаследован от NumberExtendable.)
В начало страницы
Методы расширения
  ИмяОписание
Открытый метод расширенияGet (Определяется ComHelper.)
Открытый метод расширенияInternalMarkerCanvas
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.)
Открытый метод расширенияInvoke (Определяется ComHelper.)
Открытый метод расширенияSet (Определяется ComHelper.)
В начало страницы
См. также