Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryDialog

Dialog Subtype that represents a 'Query Dialog'. A 'Query' represents and is backed by a list of Records and a single Record definition. See Record and RecordDef.

Hierarchy

Index

Properties

Private _defaultActionId

_defaultActionId: string

Private _scroller

_scroller: QueryScroller

availableViews

availableViews: ViewDescriptor[]

businessClassName

businessClassName: string

children

children: Dialog[] = []

description

description: string

dialogClassName

dialogClassName: string

dialogMode

dialogMode: DialogMode

header

header: View

id

id: string

positionalQueryAbility

positionalQueryAbility: PositionalQueryAbilityType

recordDef

recordDef: RecordDef

referringObject

referringObject: ReferringObject

selectedViewId

selectedViewId: string

sessionId

sessionId: string

supportsColumnStatistics

supportsColumnStatistics: boolean

supportsPositionalQueries

supportsPositionalQueries: boolean

tenantId

tenantId: string

type

view

view: View

viewMode

viewMode: ViewMode

Static BINARY_CHUNK_SIZE

BINARY_CHUNK_SIZE: number = 256 * 1024

Accessors

catavolt

defaultActionId

  • get defaultActionId(): string
  • Returns string

error

  • Return the error associated with this dialog, if any

    Returns DialogException

hasError

  • get hasError(): boolean
  • Returns whether or not this dialog loaded properly

    Returns boolean

isDestroyed

  • get isDestroyed(): boolean
  • Returns whether or not this Form is destroyed

    Returns boolean

isRefreshNeeded

  • get isRefreshNeeded(): boolean
  • Returns whether or not the data in this dialog is out of date

    Returns boolean

lastRefreshTime

  • get lastRefreshTime(): Date
  • set lastRefreshTime(time: Date): void
  • Get the last time this dialog's data was refreshed

    Returns Date

  • Get the last time this dialog's data was refreshed

    Parameters

    • time: Date

    Returns void

menu

  • Get the all Menu's associated with this dialog

    Returns Menu

paneTitle

  • get paneTitle(): string
  • Get the title of this dialog

    Returns string

scroller

  • Get the associated QueryScroller

    Returns QueryScroller

viewDescs

Methods

binaryAt

  • binaryAt(propName: string, record: Record): Promise<Binary>
  • Load a Binary property from a record

    Parameters

    • propName: string
    • record: Record

    Returns Promise<Binary>

Private defaultScroller

  • Creates a new QueryScroller with default buffer size of 50

    Returns QueryScroller

destroy

  • destroy(): void
  • Returns void

findMenuAt

  • findMenuAt(actionId: string): Menu
  • Find a menu def on this dialog with the given actionId

    Parameters

    • actionId: string

    Returns Menu

formatForRead

  • formatForRead(prop: Property, propName: string): string
  • Get a string representation of this property suitable for 'reading'

    Parameters

    Returns string

formatForWrite

  • formatForWrite(prop: Property, propName: string): string
  • Get a string representation of this property suitable for 'writing'

    Parameters

    Returns string

initScroller

  • initScroller(pageSize: number, firstObjectId?: string, markerOptions?: QueryMarkerOption[]): void
  • Parameters

    • pageSize: number
    • Default value firstObjectId: string = null
    • Default value markerOptions: QueryMarkerOption[] = [QueryMarkerOption.None]

    Returns void

initialize

Protected invokeMenuAction

  • Perform this action associated with the given Menu on this dialog. The targets array is expected to be an array of object ids.

    Parameters

    Returns Promise<object | Redirection>

    | Redirection>}

Protected invokeMenuActionWithId

isBinary

  • isBinary(column: Column): boolean
  • Parameters

    Returns boolean

openView

openViewWithId

  • openViewWithId(viewId: string): Promise<Dialog>

parseValue

  • parseValue(formattedValue: any, propName: string): any
  • Parses a value to prepare for 'writing' back to the server

    Parameters

    • formattedValue: any
    • propName: string

    Returns any

performMenuAction

  • performMenuAction(menu: Menu, targets: string[]): Promise<object | Redirection>
  • Perform this action associated with the given Menu on this dialog. The targets array is expected to be an array of object ids.

    Parameters

    • menu: Menu
    • targets: string[]

    Returns Promise<object | Redirection>

    | Redirection>}

performMenuActionWithId

  • performMenuActionWithId(actionId: string, targets: string[]): Promise<object | Redirection>
  • Parameters

    • actionId: string
    • targets: string[]

    Returns Promise<object | Redirection>

propDefAtName

  • Get the property definition for a property name

    Parameters

    • propName: string

    Returns PropertyDef

query

  • Perform a query

    Parameters

    Returns Promise<RecordSet>

readBinaries

Protected readBinary

  • readBinary(propName: string, record: Record): Promise<Binary>

Protected updateSettingsWithNewDialogProperties

  • updateSettingsWithNewDialogProperties(referringObject: ReferringObject): void

writeAttachment

  • writeAttachment(attachment: Attachment): Promise<void>

writeAttachments

  • writeAttachments(record: Record): Promise<void[]>

writeBinaries

  • writeBinaries(record: Record): Promise<void[]>
  • Write all Binary values in this Record back to the server

    Parameters

    Returns Promise<void[]>

Generated using TypeDoc