Class ViewSpecialParameters

Hierarchy

ViewSpecialParameters

Implements

IViewSpecialParameters

Constructors

constructor

new ViewSpecialParameters(_session: ISession): ViewSpecialParameters
Parameters
- _session: ISession
Returns ViewSpecialParameters
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:15

Methods

getCurrentCardIdParameter

getCurrentCardIdParameter(cardId: string, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- cardId: string
- hidden: boolean = true
- readOnly: boolean = true
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getCurrentCardIdParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:281

getCurrentCardIdParameterMetadata

getCurrentCardIdParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getCurrentCardIdParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:105

getCurrentUserParameter

getCurrentUserParameter(hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getCurrentUserParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:157
getCurrentUserParameter(userId: string, userName: string, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- userId: string
- userName: string
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getCurrentUserParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:158

getCurrentUserParameterMetadata

getCurrentUserParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getCurrentUserParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:21

getFormatSettingsParameter

getFormatSettingsParameter(hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getFormatSettingsParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:224
getFormatSettingsParameter(formatName: string, text: string, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- formatName: string
- text: string
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getFormatSettingsParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:225

getFormatSettingsParameterMetadata

getFormatSettingsParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getFormatSettingsParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:45

getLocaleParameter

getLocaleParameter(hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getLocaleParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:191
getLocaleParameter(localeCode: string, text: string, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- localeCode: string
- text: string
- Optional hidden: boolean
- Optional readOnly: boolean
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getLocaleParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:192

getLocaleParameterMetadata

getLocaleParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getLocaleParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:33

getMSSQLParameterMetadata

getMSSQLParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getMSSQLParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:81

getPageLimitParameter

getPageLimitParameter(pageLimit?: number, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- pageLimit: number = 20
- hidden: boolean = true
- readOnly: boolean = true
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getPageLimitParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:259

getPageLimitParameterMetadata

getPageLimitParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getPageLimitParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:57

getPageOffsetParameter

getPageOffsetParameter(currentPage?: number, pageLimit?: number, hidden?: boolean, readOnly?: boolean): ViewRequestParameter
Parameters
- currentPage: number = 1
- pageLimit: number = 20
- hidden: boolean = true
- readOnly: boolean = true
Returns ViewRequestParameter
Implementation of IViewSpecialParameters.getPageOffsetParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:267

getPageOffsetParameterMetadata

getPageOffsetParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getPageOffsetParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:69

getPostgreSQLParameterMetadata

getPostgreSQLParameterMetadata(hidden?: boolean): ViewParameterMetadata
Parameters
- hidden: boolean = false
Returns ViewParameterMetadata
Implementation of IViewSpecialParameters.getPostgreSQLParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:93

provideCurrentCardIdParameter

provideCurrentCardIdParameter(parameters: ViewRequestParameter[], cardId: string): void
Parameters
- parameters: ViewRequestParameter[]
- cardId: string
Returns void
Implementation of IViewSpecialParameters.provideCurrentCardIdParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:413

provideCurrentUserIdParameter

provideCurrentUserIdParameter(parameters: ViewRequestParameter[]): void
Parameters
- parameters: ViewRequestParameter[]
Returns void
Implementation of IViewSpecialParameters.provideCurrentUserIdParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:293

provideFormatSettingsParameter

provideFormatSettingsParameter(parameters: ViewRequestParameter[]): void
Parameters
- parameters: ViewRequestParameter[]
Returns void
Implementation of IViewSpecialParameters.provideFormatSettingsParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:327

provideLocaleParameter

provideLocaleParameter(parameters: ViewRequestParameter[]): void
Parameters
- parameters: ViewRequestParameter[]
Returns void
Implementation of IViewSpecialParameters.provideLocaleParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:310

providePageLimitParameter

providePageLimitParameter(parameters: ViewRequestParameter[], paging: Paging, pageLimit: number, optionalPaging: boolean): void
Parameters
- parameters: ViewRequestParameter[]
- paging: Paging
- pageLimit: number
- optionalPaging: boolean
Returns void
Implementation of IViewSpecialParameters.providePageLimitParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:344

providePageOffsetParameter

providePageOffsetParameter(parameters: ViewRequestParameter[], paging: Paging, currentPage: number, pageLimit: number, optionalPaging: boolean): void
Parameters
- parameters: ViewRequestParameter[]
- paging: Paging
- currentPage: number
- pageLimit: number
- optionalPaging: boolean
Returns void
Implementation of IViewSpecialParameters.providePageOffsetParameter
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:378

tryGetSpecialParameterMetadata

tryGetSpecialParameterMetadata(alias: string, hidden?: boolean): null | ViewParameterMetadata
Parameters
- alias: string
- hidden: boolean = false
Returns null | ViewParameterMetadata
Implementation of IViewSpecialParameters.tryGetSpecialParameterMetadata
- Defined in @tessa/platform/src/views/viewSpecialParameters.ts:117

Class ViewSpecialParameters

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

_session: ISession

Returns ViewSpecialParameters

Methods

getCurrentCardIdParameter

Parameters

cardId: string

hidden: boolean = true

readOnly: boolean = true

Returns ViewRequestParameter

getCurrentCardIdParameterMetadata

Parameters

hidden: boolean = false

Returns ViewParameterMetadata

getCurrentUserParameter

Parameters

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

Parameters

userId: string

userName: string

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

getCurrentUserParameterMetadata

Parameters

hidden: boolean = false

Returns ViewParameterMetadata

getFormatSettingsParameter

Parameters

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

Parameters

formatName: string

text: string

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

getFormatSettingsParameterMetadata

Parameters

hidden: boolean = false

Returns ViewParameterMetadata

getLocaleParameter

Parameters

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

Parameters

localeCode: string

text: string

Optional hidden: boolean

Optional readOnly: boolean

Returns ViewRequestParameter

getLocaleParameterMetadata

Parameters

hidden: boolean = false

Returns ViewParameterMetadata

getMSSQLParameterMetadata

Parameters

hidden: boolean = false

Returns ViewParameterMetadata

getPageLimitParameter

Parameters

pageLimit: number = 20

hidden: boolean = true

readOnly: boolean = true

Returns ViewRequestParameter

getPageLimitParameterMetadata

Parameters

hidden: boolean = false

`Optional` hidden: boolean

`Optional` readOnly: boolean

`Optional` hidden: boolean

`Optional` readOnly: boolean

`Optional` hidden: boolean

`Optional` readOnly: boolean

`Optional` hidden: boolean

`Optional` readOnly: boolean

`Optional` hidden: boolean

`Optional` readOnly: boolean

`Optional` hidden: boolean

`Optional` readOnly: boolean