DocumentNumberDirector - класс

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

Definition

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

public class DocumentNumberDirector : NumberDirector

Public Class DocumentNumberDirector
	Inherits NumberDirector

C++

public ref class DocumentNumberDirector : public NumberDirector

type DocumentNumberDirector = 
    class
        inherit NumberDirector
    end

Inheritance: Object NumberExtendable NumberBuilder NumberDirectorBase 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	Уведомляет о том, что на стороне клиента закрывается вкладка с карточкой. При этом может потребоваться освободить номер, если он был зарезервирован и ещё не был занят. (Унаследован от NumberDirector)
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)
Invoke	(Определяется ComHelper)
Set	(Определяется ComHelper)

См. также

Ссылки

Tessa.Extensions.Default.Shared.Numbers - пространство имён