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

Protected _parentDialog

_parentDialog: any

Private _scroller

_scroller: QueryScroller

availableViews

availableViews: Array<ViewDescriptor>

businessClassName

businessClassName: string

children

children: Array<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

error

hasError

  • get hasError(): boolean

isDestroyed

  • get isDestroyed(): boolean

isRefreshNeeded

  • get isRefreshNeeded(): boolean

lastRefreshTime

  • get lastRefreshTime(): Date
  • set lastRefreshTime(time: Date): void

menu

paneTitle

  • get paneTitle(): string

parentDialog

scroller

viewDescs

Methods

binaryAt

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

destroy

  • destroy(): void

findMenuAt

  • findMenuAt(actionId: string): Menu

formatForRead

  • formatForRead(prop: Property, propName: string): string

formatForWrite

  • formatForWrite(prop: Property, propName: string): string

initialize

Protected invokeMenuAction

Protected invokeMenuActionWithId

isBinary

  • isBinary(column: Column): boolean
  • Returns whether or not a column is of a binary type

    Parameters

    Returns boolean

newScroller

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: Array<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: Array<string>

    Returns Promise<object | Redirection>

    | Redirection>}

performMenuActionWithId

  • performMenuActionWithId(actionId: string, targets: Array<string>): Promise<object | Redirection>

propDefAtName

query

  • Perform a query Note: QueryScroller is the preferred way to perform a query. see {@link QueryContext.newScroller} and {@link QueryContext.setScroller}

    Parameters

    Returns Promise<RecordSet>

readBinaries

Protected readBinary

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

refresh

  • refresh(): Promise<Array<Record>>
  • Clear the QueryScroller's buffer and perform this query

    Returns Promise<Array<Record>>

setScroller

  • Creates a new QueryScroller with the given values

    Parameters

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

    Returns QueryScroller

Protected updateSettingsWithNewDialogProperties

  • updateSettingsWithNewDialogProperties(referringObject: ReferringObject): void

writeAttachment

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

writeAttachments

  • writeAttachments(record: Record): Promise<Array<void>>

writeBinaries

  • writeBinaries(record: Record): Promise<Array<void>>

Generated using TypeDoc