aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/odlux/apps/configurationApp/src/models/uiModels.ts
blob: 69a807a3cefc3d3df46f915878bcfc44d23b6d97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
 * ============LICENSE_START========================================================================
 * ONAP : ccsdk feature sdnr wt odlux
 * =================================================================================================
 * Copyright (C) 2019 highstreet technologies GmbH Intellectual Property. All rights reserved.
 * =================================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 * ============LICENSE_END==========================================================================
 */
export interface AccessFlags {
  "read": boolean,
  "write": boolean,
  "create": boolean
}

export interface ViewElementBase {
  "id": string;
  "label": string;
  "viewId": string;
  "leafrefPath": string;
  "accessFlags": AccessFlags;
  "description": string;
}

export interface ViewElementString extends ViewElementBase {
  "uiType": "string";
}

export interface ViewElementNumber extends ViewElementBase {
  "uiType": "number";
  "min"?: number;
  "max"?: number;
  "unit"?: string;
  "format"?: string;
}

export interface ViewElementBoolean extends ViewElementBase {
  "uiType": "boolean";
  "trueValue"?: string;
  "falseValue"?: string;
}

export interface ViewElementObject extends ViewElementBase {
  "uiType": "object";
  "viewId": string;
}

export interface ViewElementSelection extends ViewElementBase {
  "uiType": "selection";
  "multiSelect"?: boolean
  "options": {
    "key": string,
    "value": string,
    "description": string
  }[],
}

export interface ViewElementList extends ViewElementBase {
  "uiType": "list",
  "listType": "object" | "string" | "number",
  "viewId": string,
}

export type ViewElement =
  | ViewElementString
  | ViewElementNumber
  | ViewElementBoolean
  | ViewElementObject
  | ViewElementSelection
  | ViewElementList;

export interface ViewSpecification {
  "id": string;
  "parentView": string;
  "name": string;
  "language": string;
  "title"?: string;
  "url": string;
  "dataPath": string;
  "elements": ViewElement[];
}