Class CardSectionPermissionInfo

Содержит права доступа на строковую секцию карточки и на её поля.

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged name

Properties - Static Keys

fieldPermissionsKey rowsKey sectionPermissionsKey

Accessors

cachedMembers fieldPermissions isObservable rows sectionPermissions type

Methods

clean ensureCacheResolved getStorage getStorageSettings isEmpty isValid notifyStorageUpdated setFieldPermissions setSectionPermissions tryGetFieldPermissions tryGetRows validate

Constructors

constructor

  • new CardSectionPermissionInfo(
        name: string,
        storage?: IStorage,
    ): CardSectionPermissionInfo

    Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.

    Parameters

    • name: string

      Имя секции.

    • storage: IStorage = {}

      Хранилище, декоратором для которого является создаваемый объект.

    Returns CardSectionPermissionInfo

Properties - Other

ReadonlycachedMemberChanged

cachedMemberChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

ReadonlyfieldChanged

fieldChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

Readonlyname

name: string

Имя секции.

Properties - Static Keys

Static ReadonlyfieldPermissionsKey

fieldPermissionsKey: "FieldPermissions" = 'FieldPermissions'

Static ReadonlyrowsKey

rowsKey: "Rows" = 'Rows'

Static ReadonlysectionPermissionsKey

sectionPermissionsKey: "SectionPermissions" = 'SectionPermissions'

Accessors

cachedMembers

  • get cachedMembers(): ReadonlyMap<string, unknown>

    Returns ReadonlyMap<string, unknown>

fieldPermissions

  • get fieldPermissions(): TypedStorageMap<Int>

    Права доступа на отдельные поля секции.

    Returns TypedStorageMap<Int>

  • set fieldPermissions(value: TypedStorageMap<Int>): void

    Parameters

    Returns void

isObservable

  • get isObservable(): boolean

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

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

    В противном случае, если значение false, объект считается ненаблюдаемым, и изменения в его состоянии не будут автоматически передаваться другим частям программы.

    Returns boolean

  • set isObservable(value: boolean): void

    Parameters

    • value: boolean

    Returns void

rows

sectionPermissions

type

  • get type(): CardSectionType

    Тип секции карточки. Не содержится в пакете и вычисляется на основании наличия в пакете определённых полей.

    Returns CardSectionType

  • set type(value: CardSectionType): void

    Parameters

    Returns void

Methods

clean

  • clean(): void

    Выполняет очистку хранилища от избыточных данных.

    Returns void

ensureCacheResolved

  • ensureCacheResolved(): void

    Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • getStorage(): IStorage

    Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage

    Хранилище IStorage, декоратором для которого является текущий объект.

getStorageSettings

isEmpty

  • isEmpty(): boolean

    Возвращает признак того, что объект не содержит значимых данных для метода очистки.

    Returns boolean

    true, если объект не содержит значимых для метода очистки данных; false в противном случае.

isValid

  • isValid(): boolean

    Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.

    Returns boolean

    true, если объект прошёл проверку на валидность; false в противном случае.

notifyStorageUpdated

  • notifyStorageUpdated(): void

    Метод, уведомляющий объект о наличии изменений в его хранилище.

    Returns void

setFieldPermissions

  • setFieldPermissions(
        fieldName: string,
        flags: CardPermissionFlags,
        overwrite?: boolean,
    ): CardSectionPermissionInfo

    Устанавливает заданные разрешения или запреты для поля секции с именем fieldName.

    Parameters

    • fieldName: string

      Имя поля, для которого устанавливается разрешение или запрет.

    • flags: CardPermissionFlags

      Устанавливаемые разрешения или запреты. Для указания разрешения задавайте только флаг Allow, а для запрета - только флаг Prohibit.

    • overwrite: boolean = false

      Признак того, что требуется заменить все имеющиеся разрешения и запреты.

    Returns CardSectionPermissionInfo

    Текущий объект для цепочки вызовов.

setSectionPermissions

  • setSectionPermissions(
        flags: CardPermissionFlags,
        overwrite?: boolean,
    ): CardSectionPermissionInfo

    Устанавливает заданные разрешения или запреты для секции.

    Parameters

    • flags: CardPermissionFlags

      Устанавливаемые разрешения или запреты. Для указания разрешения задавайте только флаг Allow, а для запрета - только флаг Prohibit.

    • overwrite: boolean = false

      Признак того, что требуется заменить все имеющиеся разрешения и запреты.

    Returns CardSectionPermissionInfo

    Текущий объект для цепочки вызовов.

tryGetFieldPermissions

  • tryGetFieldPermissions(): null | TypedStorageMap<Int, number>

    Возвращает права доступа на отдельные поля секции или null, если права ещё не были заданы.

    Returns null | TypedStorageMap<Int, number>

    Права доступа на отдельные поля секции или null, если права ещё не были заданы.

tryGetRows

  • tryGetRows(): null | StorageMap<CardRowPermissionInfo, IStorage>

    Возвращает права доступа на отдельные строки коллекционной или древовидной секции или null, если права ещё не были заданы.

    Returns null | StorageMap<CardRowPermissionInfo, IStorage>

    Права доступа на отдельные строки коллекционной или древовидной секции или null, если права ещё не были заданы.

validate

  • validate(): ValidationResult

    Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns ValidationResult

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

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR