Options
All
  • Public
  • Public/Protected
  • All
Menu

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 _scroller

_scroller: QueryScroller

availableViews

availableViews: ViewDescriptor[]

children

children: Dialog[] = []

description

description: string

dialogClassName

dialogClassName: string

dialogMode

dialogMode: DialogMode

domainClassName

domainClassName: string

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 = 128 * 1024

Static SEARCH_DIALOG_CLASS

SEARCH_DIALOG_CLASS: string = "SearchQueryModel"

Accessors

anyChildNeedsRefresh

  • get anyChildNeedsRefresh(): boolean

catavolt

defaultActionId

  • get defaultActionId(): string

error

hasError

  • get hasError(): boolean

isDestroyed

  • get isDestroyed(): boolean

isReadViewMode

  • get isReadViewMode(): boolean

isRefreshNeeded

  • get isRefreshNeeded(): boolean

lastRefreshTime

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

menu

paneTitle

  • get paneTitle(): string

scroller

viewDescs

Methods

Private defaultScroller

destroy

  • destroy(): Promise<void>

findMenuAt

  • findMenuAt(actionId: string): Menu

formatForRead

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

formatForWrite

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

Protected getProperty

initScroller

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

initialize

Protected invokeMenuAction

Protected invokeMenuActionWithId

isBinary

  • isBinary(column: Column): boolean

openSearch

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

  • 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<Redirection>

    | Redirection>}

performMenuActionWithId

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

propDefAtName

query

readLargeProperties

  • readLargeProperties(recordId: string): Promise<LargeProperty[]>

readLargeProperty

  • readLargeProperty(propertyName: string, recordId?: string): Promise<LargeProperty>

streamLargeProperty

  • Stream the encoded chunks of a large property without retaining them The streamConsumer will receive Base64 encoded chunks with callbacks. hasMore will be false with the final chunk.

    Parameters

    • streamConsumer: StreamConsumer
    • propertyName: string
    • Optional recordId: string

    Returns Promise<LargeProperty>

Protected updateSettingsWithNewDialogProperties

  • updateSettingsWithNewDialogProperties(referringObject: ReferringObject): void

Protected writeAttachment

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

Protected writeAttachments

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

Protected writeLargeProperties

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

Protected writeLargeProperty

  • writeLargeProperty(propertyName: string, largeProperty: LargeProperty): Promise<void>

Static isSearchDialog

  • isSearchDialog(dialog: any): boolean

Static loadLargeProperty

  • loadLargeProperty(getPropertyFn: function, streamConsumer?: StreamConsumer, propertyName?: string, recordId?: string): Promise<LargeProperty>

Generated using TypeDoc