@dangl/ava-model 2.30.1 → 2.30.2-beta0007
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,327 +1,187 @@
|
|
|
1
|
-
/** This enum configures rounding modes for price calculations in projects */
|
|
2
1
|
declare enum PriceRoundingModeDto {
|
|
3
2
|
Normal = "Normal",
|
|
4
3
|
Floor = "Floor",
|
|
5
4
|
Ceiling = "Ceiling"
|
|
6
5
|
}
|
|
7
|
-
/** General information about a Project. */
|
|
8
6
|
declare class ProjectInformationDto implements IProjectInformationDto {
|
|
9
|
-
/** Information about the buyer. */
|
|
10
7
|
buyer?: PartyInformationDto | undefined;
|
|
11
|
-
/** Description for the project. */
|
|
12
8
|
description?: string | undefined;
|
|
13
|
-
/** Short description for the project. */
|
|
14
9
|
descriptionShort?: string | undefined;
|
|
15
|
-
/** Name of the project. */
|
|
16
10
|
name?: string | undefined;
|
|
17
|
-
/** Information about the site. */
|
|
18
11
|
site?: PartyInformationDto | undefined;
|
|
19
|
-
/** The ItemNumberSchema used in the project. */
|
|
20
12
|
itemNumberSchema?: ItemNumberSchemaDto | undefined;
|
|
21
|
-
/** Short label for the currency used. */
|
|
22
13
|
currencyShort?: string | undefined;
|
|
23
|
-
/** Full label of the currency used. */
|
|
24
14
|
currencyLong?: string | undefined;
|
|
25
|
-
/** Label for the labour time part of prices used in the project. */
|
|
26
15
|
labourTimeLabel?: string | undefined;
|
|
27
|
-
/** Labels for the price components used in the project. Caution: Removal of a price component will trigger to have dependent price informations be deleted in IElements that use this property. If this property is changed or altered after the project has already been used, it is strongly advised to do operations step by step, e.g. if renaming and reordering multiple price components, this should be done one by one. Otherwise, a combination of rename and reordering will not be correctly propagated downwards to child objects in this Project. */
|
|
28
16
|
priceComponents?: string[] | undefined;
|
|
29
|
-
/** This dictionary specifies actual types used for the PriceComponents. For example, a single price component might have the name 'Material' as a string, ans this dictionary would then have a key 'Material' and a value of Materials. You can not add keys here that are not also present in the PriceComponents property, and removing price components will also remove them from this dictionary here. */
|
|
30
17
|
readonly priceComponentTypes?: {
|
|
31
18
|
[key: string]: PriceComponentTypeDto;
|
|
32
19
|
} | undefined;
|
|
33
|
-
/** This bool indicates if this project allows the bidder to add bidder comments. Bidder comments are a way to attach clarifying information when submitting an offer. */
|
|
34
20
|
bidderCommentAllowed: boolean;
|
|
35
|
-
/** This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85. */
|
|
36
21
|
sideOffersAllowed: boolean;
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
/** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
|
|
40
|
-
specialAwardKind: SpecialAwardKindDto;
|
|
41
|
-
/** Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners. */
|
|
22
|
+
awardType?: AwardTypeDto | undefined;
|
|
23
|
+
specialAwardKind?: SpecialAwardKindDto | undefined;
|
|
42
24
|
requesters?: PartyInformationDto[] | undefined;
|
|
43
|
-
/** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
|
|
44
25
|
notificationSites?: PartyInformationDto[] | undefined;
|
|
45
26
|
constructor(data?: IProjectInformationDto);
|
|
46
27
|
init?(_data?: any): void;
|
|
47
28
|
static fromJS(data: any): ProjectInformationDto;
|
|
48
29
|
toJSON?(data?: any): any;
|
|
49
30
|
}
|
|
50
|
-
/** General information about a Project. */
|
|
51
31
|
interface IProjectInformationDto {
|
|
52
|
-
/** Information about the buyer. */
|
|
53
32
|
buyer?: IPartyInformationDto | undefined;
|
|
54
|
-
/** Description for the project. */
|
|
55
33
|
description?: string | undefined;
|
|
56
|
-
/** Short description for the project. */
|
|
57
34
|
descriptionShort?: string | undefined;
|
|
58
|
-
/** Name of the project. */
|
|
59
35
|
name?: string | undefined;
|
|
60
|
-
/** Information about the site. */
|
|
61
36
|
site?: IPartyInformationDto | undefined;
|
|
62
|
-
/** The ItemNumberSchema used in the project. */
|
|
63
37
|
itemNumberSchema?: IItemNumberSchemaDto | undefined;
|
|
64
|
-
/** Short label for the currency used. */
|
|
65
38
|
currencyShort?: string | undefined;
|
|
66
|
-
/** Full label of the currency used. */
|
|
67
39
|
currencyLong?: string | undefined;
|
|
68
|
-
/** Label for the labour time part of prices used in the project. */
|
|
69
40
|
labourTimeLabel?: string | undefined;
|
|
70
|
-
/** Labels for the price components used in the project. Caution: Removal of a price component will trigger to have dependent price informations be deleted in IElements that use this property. If this property is changed or altered after the project has already been used, it is strongly advised to do operations step by step, e.g. if renaming and reordering multiple price components, this should be done one by one. Otherwise, a combination of rename and reordering will not be correctly propagated downwards to child objects in this Project. */
|
|
71
41
|
priceComponents?: string[] | undefined;
|
|
72
|
-
/** This dictionary specifies actual types used for the PriceComponents. For example, a single price component might have the name 'Material' as a string, ans this dictionary would then have a key 'Material' and a value of Materials. You can not add keys here that are not also present in the PriceComponents property, and removing price components will also remove them from this dictionary here. */
|
|
73
42
|
priceComponentTypes?: {
|
|
74
43
|
[key: string]: PriceComponentTypeDto;
|
|
75
44
|
} | undefined;
|
|
76
|
-
/** This bool indicates if this project allows the bidder to add bidder comments. Bidder comments are a way to attach clarifying information when submitting an offer. */
|
|
77
45
|
bidderCommentAllowed: boolean;
|
|
78
|
-
/** This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85. */
|
|
79
46
|
sideOffersAllowed: boolean;
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
/** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
|
|
83
|
-
specialAwardKind: SpecialAwardKindDto;
|
|
84
|
-
/** Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners. */
|
|
47
|
+
awardType?: AwardTypeDto | undefined;
|
|
48
|
+
specialAwardKind?: SpecialAwardKindDto | undefined;
|
|
85
49
|
requesters?: IPartyInformationDto[] | undefined;
|
|
86
|
-
/** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
|
|
87
50
|
notificationSites?: IPartyInformationDto[] | undefined;
|
|
88
51
|
}
|
|
89
|
-
/** Represents information about a party (a site or an organization). */
|
|
90
52
|
declare class PartyInformationDto implements IPartyInformationDto {
|
|
91
|
-
/** Elements GUID identifier. */
|
|
92
53
|
id: string;
|
|
93
|
-
/** This party's name. */
|
|
94
54
|
name?: string | undefined;
|
|
95
|
-
/** This party's street. */
|
|
96
55
|
street?: string | undefined;
|
|
97
|
-
/** This party's ZipCode. */
|
|
98
56
|
zipCode?: string | undefined;
|
|
99
|
-
/** This party's City. */
|
|
100
57
|
city?: string | undefined;
|
|
101
|
-
/** This party's Country. */
|
|
102
58
|
country?: string | undefined;
|
|
103
|
-
/** This party's Identifier. */
|
|
104
59
|
identifier?: string | undefined;
|
|
105
|
-
/** Remarks for this party. */
|
|
106
60
|
remarks?: string | undefined;
|
|
107
|
-
/** An email address for this party. */
|
|
108
61
|
email?: string | undefined;
|
|
109
|
-
/** A phone number for this party. */
|
|
110
62
|
phone?: string | undefined;
|
|
111
|
-
/** The name of a contact person. */
|
|
112
63
|
contactPersonName?: string | undefined;
|
|
113
|
-
/** This is an identifier related to this PartyInformation and their internal reference of the tender (or award). This might be used to assign an identifier (German "Vergabenummer") for the current project. This is typically only used in Buyer and Bidder representations and should map to the concept of "Vergabenummer" or "AwardNo" in GAEB. */
|
|
114
64
|
awardIdentifier?: string | undefined;
|
|
115
|
-
/** This property indicates if the party is registered within the European Economic Area. */
|
|
116
65
|
isInEuropeanEconomicArea: boolean;
|
|
117
|
-
/** If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id. */
|
|
118
66
|
vatId?: string | undefined;
|
|
119
|
-
/** The fax number for this party. */
|
|
120
67
|
fax?: string | undefined;
|
|
121
|
-
/** The two letter ISO country code, e.g. DE for Germany. */
|
|
122
68
|
countryCode?: string | undefined;
|
|
123
|
-
/** Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems. */
|
|
124
69
|
creditorOrDebtorIdentifier?: string | undefined;
|
|
125
|
-
/** The Global Location Number (GLN) is issued by GS1 and is intended to be a unique identifier for the physical address of a party, e.g. a business office. */
|
|
126
70
|
globalLocationNumber?: string | undefined;
|
|
127
|
-
/** This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders. */
|
|
128
71
|
bankingInformation?: BankingInformationDto[] | undefined;
|
|
129
|
-
/** This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company. */
|
|
130
72
|
registrationNumber?: string | undefined;
|
|
131
|
-
/** This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices. */
|
|
132
73
|
taxId?: string | undefined;
|
|
133
74
|
constructor(data?: IPartyInformationDto);
|
|
134
75
|
init?(_data?: any): void;
|
|
135
76
|
static fromJS(data: any): PartyInformationDto;
|
|
136
77
|
toJSON?(data?: any): any;
|
|
137
78
|
}
|
|
138
|
-
/** Represents information about a party (a site or an organization). */
|
|
139
79
|
interface IPartyInformationDto {
|
|
140
|
-
/** Elements GUID identifier. */
|
|
141
80
|
id: string;
|
|
142
|
-
/** This party's name. */
|
|
143
81
|
name?: string | undefined;
|
|
144
|
-
/** This party's street. */
|
|
145
82
|
street?: string | undefined;
|
|
146
|
-
/** This party's ZipCode. */
|
|
147
83
|
zipCode?: string | undefined;
|
|
148
|
-
/** This party's City. */
|
|
149
84
|
city?: string | undefined;
|
|
150
|
-
/** This party's Country. */
|
|
151
85
|
country?: string | undefined;
|
|
152
|
-
/** This party's Identifier. */
|
|
153
86
|
identifier?: string | undefined;
|
|
154
|
-
/** Remarks for this party. */
|
|
155
87
|
remarks?: string | undefined;
|
|
156
|
-
/** An email address for this party. */
|
|
157
88
|
email?: string | undefined;
|
|
158
|
-
/** A phone number for this party. */
|
|
159
89
|
phone?: string | undefined;
|
|
160
|
-
/** The name of a contact person. */
|
|
161
90
|
contactPersonName?: string | undefined;
|
|
162
|
-
/** This is an identifier related to this PartyInformation and their internal reference of the tender (or award). This might be used to assign an identifier (German "Vergabenummer") for the current project. This is typically only used in Buyer and Bidder representations and should map to the concept of "Vergabenummer" or "AwardNo" in GAEB. */
|
|
163
91
|
awardIdentifier?: string | undefined;
|
|
164
|
-
/** This property indicates if the party is registered within the European Economic Area. */
|
|
165
92
|
isInEuropeanEconomicArea: boolean;
|
|
166
|
-
/** If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id. */
|
|
167
93
|
vatId?: string | undefined;
|
|
168
|
-
/** The fax number for this party. */
|
|
169
94
|
fax?: string | undefined;
|
|
170
|
-
/** The two letter ISO country code, e.g. DE for Germany. */
|
|
171
95
|
countryCode?: string | undefined;
|
|
172
|
-
/** Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems. */
|
|
173
96
|
creditorOrDebtorIdentifier?: string | undefined;
|
|
174
|
-
/** The Global Location Number (GLN) is issued by GS1 and is intended to be a unique identifier for the physical address of a party, e.g. a business office. */
|
|
175
97
|
globalLocationNumber?: string | undefined;
|
|
176
|
-
/** This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders. */
|
|
177
98
|
bankingInformation?: IBankingInformationDto[] | undefined;
|
|
178
|
-
/** This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company. */
|
|
179
99
|
registrationNumber?: string | undefined;
|
|
180
|
-
/** This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices. */
|
|
181
100
|
taxId?: string | undefined;
|
|
182
101
|
}
|
|
183
|
-
/** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
|
|
184
102
|
declare class BankingInformationDto implements IBankingInformationDto {
|
|
185
|
-
/** Elements GUID identifier. */
|
|
186
103
|
id: string;
|
|
187
|
-
/** The name of the bank. */
|
|
188
104
|
name?: string | undefined;
|
|
189
|
-
/** The international identifier for the bank account. */
|
|
190
105
|
iban?: string | undefined;
|
|
191
|
-
/** The account number. Typically no longer used since the introduction of IBAN within the SEPA area. */
|
|
192
106
|
accountNumber?: string | undefined;
|
|
193
|
-
/** The international bank identifier. */
|
|
194
107
|
bic?: string | undefined;
|
|
195
|
-
/** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
|
|
196
108
|
routingNumber?: string | undefined;
|
|
197
109
|
constructor(data?: IBankingInformationDto);
|
|
198
110
|
init?(_data?: any): void;
|
|
199
111
|
static fromJS(data: any): BankingInformationDto;
|
|
200
112
|
toJSON?(data?: any): any;
|
|
201
113
|
}
|
|
202
|
-
/** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
|
|
203
114
|
interface IBankingInformationDto {
|
|
204
|
-
/** Elements GUID identifier. */
|
|
205
115
|
id: string;
|
|
206
|
-
/** The name of the bank. */
|
|
207
116
|
name?: string | undefined;
|
|
208
|
-
/** The international identifier for the bank account. */
|
|
209
117
|
iban?: string | undefined;
|
|
210
|
-
/** The account number. Typically no longer used since the introduction of IBAN within the SEPA area. */
|
|
211
118
|
accountNumber?: string | undefined;
|
|
212
|
-
/** The international bank identifier. */
|
|
213
119
|
bic?: string | undefined;
|
|
214
|
-
/** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
|
|
215
120
|
routingNumber?: string | undefined;
|
|
216
121
|
}
|
|
217
|
-
/** The schema for ItemNumber's in a Project. */
|
|
218
122
|
declare class ItemNumberSchemaDto implements IItemNumberSchemaDto {
|
|
219
|
-
/** The count of tiers in the ItemNumberSchema */
|
|
220
123
|
readonly totalLength: number;
|
|
221
|
-
/** The collection of tiers for this ItemNumberSchema. */
|
|
222
124
|
tiers?: ItemNumberSchemaTierDto[] | undefined;
|
|
223
|
-
/** The separator to use for separiting the different levels in an ItemNumber. Defaults to DEFAULT_SEPARATOR, which is a point '.'. Setting this to a space or other whitespaces is discouraged, as this might not work correct in all situations and item numbers could be displayed not as intended. This can not be set to an empty or null string, trying that will default to the DEFAULT_SEPARATOR. If a value is set that has a different length than one '1', the DEFAULT_SEPARATOR will be used instead. You should also not use values for the separator that are also valid for the item numbers themselves, as that might also lead to incorrect results */
|
|
224
125
|
separator?: string | undefined;
|
|
225
|
-
/** This string is used to fill (left-pad) item numbers. For example, if a tier has a length of '4' but the given item number is '12', with a Filler of '0', then the final item number will be represented as '0'. This must be a single character string, if a value is given where the Length property does not evaluate to '1', the DEFAULT_FILLER '0' is used. A space is fine to use. You should ensure that you use a value different than Separator, as that might produce unexpected results. No attempt is done by the code to recover from such ambiguous configurations. */
|
|
226
126
|
filler?: string | undefined;
|
|
227
|
-
/** This is just a string property that can optionally be used to store additional data for this ItemNumberSchema, e.g. an identification or a type. It does not have any influence over how item numbers are generated, and is not supported in most exchange formats. However, it is used to store ÖNorm service specification structure types. */
|
|
228
127
|
identifier?: string | undefined;
|
|
229
|
-
/** This property indicates if ItemNumbers using this ItemNumberSchema should skip empty group levels. This is commonly only used in GAEB files, where there might be gaps in the hierarchy of elements and position identifiers should be placed at the end of the string representation. */
|
|
230
128
|
skipNonExistingLevelsInPositionItemNumbers: boolean;
|
|
231
|
-
/** This string is used only when the property SkipNonExistingLevelsInPositionItemNumbers in this ItemNumberSchema is also set to true. It defaults to DEFAULT_SKIPPED_TIERS_FILLER, but can be set to any string with a lenght of one. Null values or values with a longer length will lead to this property reverting back to the default value. This is used to fill skipped tiers in item numbers where a position is placed in a higher hierarchy level than what would be defined in the Tiers. For example, it could produce an item number like '01.__.02', which would indicate a skipped second level. This should be using different values than Filler and Separator, since that could cause ambiguities in the code that generates the actual item numbers. No attempt is done by the code to recover from such ambiguous configurations. */
|
|
232
129
|
skippedTiersFiller?: string | undefined;
|
|
233
|
-
/** This is a read-only property that indicates if this schema has a valid structure. It internally just returns the result from IsCorrectlyDefined. This will return if the ItemNumberSchema is correctly defined. For it to be correctly defined, the following conditions must be true: There may only be one lot group, if there is one, it must be at the top. Following lot levels, there may be at least one group level. After the group levels, there must be one position level. After the position level, there may be one index level. If no tiers are defined at all, this will also return false. */
|
|
234
130
|
readonly schemaIsCorrectlyDefined: boolean;
|
|
235
|
-
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
236
131
|
allowUpperCaseLettering: boolean;
|
|
237
|
-
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
238
132
|
disableLeftPaddingTiersWithFiller: boolean;
|
|
239
|
-
/** If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project. */
|
|
240
133
|
disableItemNumberIdentifierTransformations: boolean;
|
|
241
|
-
/** This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed */
|
|
242
134
|
disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
|
|
243
135
|
constructor(data?: IItemNumberSchemaDto);
|
|
244
136
|
init?(_data?: any): void;
|
|
245
137
|
static fromJS(data: any): ItemNumberSchemaDto;
|
|
246
138
|
toJSON?(data?: any): any;
|
|
247
139
|
}
|
|
248
|
-
/** The schema for ItemNumber's in a Project. */
|
|
249
140
|
interface IItemNumberSchemaDto {
|
|
250
|
-
/** The count of tiers in the ItemNumberSchema */
|
|
251
141
|
totalLength: number;
|
|
252
|
-
/** The collection of tiers for this ItemNumberSchema. */
|
|
253
142
|
tiers?: IItemNumberSchemaTierDto[] | undefined;
|
|
254
|
-
/** The separator to use for separiting the different levels in an ItemNumber. Defaults to DEFAULT_SEPARATOR, which is a point '.'. Setting this to a space or other whitespaces is discouraged, as this might not work correct in all situations and item numbers could be displayed not as intended. This can not be set to an empty or null string, trying that will default to the DEFAULT_SEPARATOR. If a value is set that has a different length than one '1', the DEFAULT_SEPARATOR will be used instead. You should also not use values for the separator that are also valid for the item numbers themselves, as that might also lead to incorrect results */
|
|
255
143
|
separator?: string | undefined;
|
|
256
|
-
/** This string is used to fill (left-pad) item numbers. For example, if a tier has a length of '4' but the given item number is '12', with a Filler of '0', then the final item number will be represented as '0'. This must be a single character string, if a value is given where the Length property does not evaluate to '1', the DEFAULT_FILLER '0' is used. A space is fine to use. You should ensure that you use a value different than Separator, as that might produce unexpected results. No attempt is done by the code to recover from such ambiguous configurations. */
|
|
257
144
|
filler?: string | undefined;
|
|
258
|
-
/** This is just a string property that can optionally be used to store additional data for this ItemNumberSchema, e.g. an identification or a type. It does not have any influence over how item numbers are generated, and is not supported in most exchange formats. However, it is used to store ÖNorm service specification structure types. */
|
|
259
145
|
identifier?: string | undefined;
|
|
260
|
-
/** This property indicates if ItemNumbers using this ItemNumberSchema should skip empty group levels. This is commonly only used in GAEB files, where there might be gaps in the hierarchy of elements and position identifiers should be placed at the end of the string representation. */
|
|
261
146
|
skipNonExistingLevelsInPositionItemNumbers: boolean;
|
|
262
|
-
/** This string is used only when the property SkipNonExistingLevelsInPositionItemNumbers in this ItemNumberSchema is also set to true. It defaults to DEFAULT_SKIPPED_TIERS_FILLER, but can be set to any string with a lenght of one. Null values or values with a longer length will lead to this property reverting back to the default value. This is used to fill skipped tiers in item numbers where a position is placed in a higher hierarchy level than what would be defined in the Tiers. For example, it could produce an item number like '01.__.02', which would indicate a skipped second level. This should be using different values than Filler and Separator, since that could cause ambiguities in the code that generates the actual item numbers. No attempt is done by the code to recover from such ambiguous configurations. */
|
|
263
147
|
skippedTiersFiller?: string | undefined;
|
|
264
|
-
/** This is a read-only property that indicates if this schema has a valid structure. It internally just returns the result from IsCorrectlyDefined. This will return if the ItemNumberSchema is correctly defined. For it to be correctly defined, the following conditions must be true: There may only be one lot group, if there is one, it must be at the top. Following lot levels, there may be at least one group level. After the group levels, there must be one position level. After the position level, there may be one index level. If no tiers are defined at all, this will also return false. */
|
|
265
148
|
schemaIsCorrectlyDefined: boolean;
|
|
266
|
-
/** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
|
|
267
149
|
allowUpperCaseLettering: boolean;
|
|
268
|
-
/** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
|
|
269
150
|
disableLeftPaddingTiersWithFiller: boolean;
|
|
270
|
-
/** If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project. */
|
|
271
151
|
disableItemNumberIdentifierTransformations: boolean;
|
|
272
|
-
/** This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed */
|
|
273
152
|
disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
|
|
274
153
|
}
|
|
275
|
-
/** Represents information about a single Tier in an ItemNumber. */
|
|
276
154
|
declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto {
|
|
277
|
-
/** The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified. */
|
|
278
155
|
length: number;
|
|
279
|
-
|
|
280
|
-
type: ItemNumberTypeDto;
|
|
281
|
-
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
156
|
+
type?: ItemNumberTypeDto | undefined;
|
|
282
157
|
alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
|
|
283
|
-
|
|
284
|
-
tierType: ItemNumberSchemaTierTypeDto;
|
|
285
|
-
/** Indicates if this tier represents a lot. See the documentation for more information about lots. */
|
|
158
|
+
tierType?: ItemNumberSchemaTierTypeDto | undefined;
|
|
286
159
|
readonly isLot: boolean;
|
|
287
|
-
/** This value is the increment, or step size, that should be used for new item numbers. It defaults to DEFAULT_INCREMENT, but can be changed to any other positive number greater than zero. Invalid values make this be set to one '1' */
|
|
288
160
|
increment: number;
|
|
289
|
-
/** This is an optional name for the given tier */
|
|
290
161
|
tierName?: string | undefined;
|
|
291
162
|
constructor(data?: IItemNumberSchemaTierDto);
|
|
292
163
|
init?(_data?: any): void;
|
|
293
164
|
static fromJS(data: any): ItemNumberSchemaTierDto;
|
|
294
165
|
toJSON?(data?: any): any;
|
|
295
166
|
}
|
|
296
|
-
/** Represents information about a single Tier in an ItemNumber. */
|
|
297
167
|
interface IItemNumberSchemaTierDto {
|
|
298
|
-
/** The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified. */
|
|
299
168
|
length: number;
|
|
300
|
-
|
|
301
|
-
type: ItemNumberTypeDto;
|
|
302
|
-
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
169
|
+
type?: ItemNumberTypeDto | undefined;
|
|
303
170
|
alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
|
|
304
|
-
|
|
305
|
-
tierType: ItemNumberSchemaTierTypeDto;
|
|
306
|
-
/** Indicates if this tier represents a lot. See the documentation for more information about lots. */
|
|
171
|
+
tierType?: ItemNumberSchemaTierTypeDto | undefined;
|
|
307
172
|
isLot: boolean;
|
|
308
|
-
/** This value is the increment, or step size, that should be used for new item numbers. It defaults to DEFAULT_INCREMENT, but can be changed to any other positive number greater than zero. Invalid values make this be set to one '1' */
|
|
309
173
|
increment: number;
|
|
310
|
-
/** This is an optional name for the given tier */
|
|
311
174
|
tierName?: string | undefined;
|
|
312
175
|
}
|
|
313
|
-
/** Determines the type of an ItemNumberSchema */
|
|
314
176
|
declare enum ItemNumberTypeDto {
|
|
315
177
|
Numeric = "Numeric",
|
|
316
178
|
Alphanumeric = "Alphanumeric"
|
|
317
179
|
}
|
|
318
|
-
/** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
|
|
319
180
|
declare enum ItemNumberSchemaTierAlignmentDto {
|
|
320
181
|
Undefined = "Undefined",
|
|
321
182
|
Left = "Left",
|
|
322
183
|
Right = "Right"
|
|
323
184
|
}
|
|
324
|
-
/** Specifies the type an ItemNumberSchemaTier represents. For example, a tier may indicate to be used for positions or for groups. */
|
|
325
185
|
declare enum ItemNumberSchemaTierTypeDto {
|
|
326
186
|
Undefined = "Undefined",
|
|
327
187
|
Index = "Index",
|
|
@@ -329,7 +189,6 @@ declare enum ItemNumberSchemaTierTypeDto {
|
|
|
329
189
|
Group = "Group",
|
|
330
190
|
Lot = "Lot"
|
|
331
191
|
}
|
|
332
|
-
/** This enumeration models types of price components for better classification. */
|
|
333
192
|
declare enum PriceComponentTypeDto {
|
|
334
193
|
Unknown = "Unknown",
|
|
335
194
|
Wages = "Wages",
|
|
@@ -337,7 +196,6 @@ declare enum PriceComponentTypeDto {
|
|
|
337
196
|
Plant = "Plant",
|
|
338
197
|
Miscellaneous = "Miscellaneous"
|
|
339
198
|
}
|
|
340
|
-
/** This enumeration describes the type of the award / procurement process. If this is used in a GAEB context, more information about award types can be found in the German VOB/A rules and the GAEB standard */
|
|
341
199
|
declare enum AwardTypeDto {
|
|
342
200
|
Unspecified = "Unspecified",
|
|
343
201
|
OpenProcurement = "OpenProcurement",
|
|
@@ -352,240 +210,135 @@ declare enum AwardTypeDto {
|
|
|
352
210
|
CompetitiveDialog = "CompetitiveDialog",
|
|
353
211
|
InnovationPartnership = "InnovationPartnership"
|
|
354
212
|
}
|
|
355
|
-
/** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
|
|
356
213
|
declare enum SpecialAwardKindDto {
|
|
357
214
|
Unspecified = "Unspecified",
|
|
358
215
|
MaintenanceContract = "MaintenanceContract",
|
|
359
216
|
OutlineContract = "OutlineContract",
|
|
360
217
|
OutlineForMaintenanceContract = "OutlineForMaintenanceContract"
|
|
361
218
|
}
|
|
362
|
-
/** This is the base class that holds information about a whole service specification. */
|
|
363
219
|
declare class ServiceSpecificationDto implements IServiceSpecificationDto {
|
|
364
|
-
/** Elements GUID identifier. */
|
|
365
220
|
id: string;
|
|
366
|
-
/** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
367
221
|
readonly projectHourlyWage: number;
|
|
368
|
-
/** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
369
222
|
projectTaxRate: number;
|
|
370
|
-
/** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
|
|
371
223
|
projectPriceComponents?: string[] | undefined;
|
|
372
|
-
/** The ItemNumberSchema that is used within this project. */
|
|
373
224
|
projectItemNumberSchema?: ItemNumberSchemaDto | undefined;
|
|
374
|
-
/** The IElements within this ElementContainerBase. */
|
|
375
225
|
elements?: IElementDto[] | undefined;
|
|
376
|
-
/** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
|
|
377
226
|
readonly projectLabourTimeLabel?: string | undefined;
|
|
378
|
-
/** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
379
227
|
readonly containsDuplicateItemNumbers: boolean;
|
|
380
|
-
/** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
381
228
|
readonly containsDuplicateElementIds: boolean;
|
|
382
|
-
/** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
383
229
|
ignoreDuplicateItemNumbers: boolean;
|
|
384
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
|
|
385
230
|
ignoreProjectCataloguePropagation: boolean;
|
|
386
|
-
/** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
387
231
|
ignoreDuplicateElementIds: boolean;
|
|
388
|
-
/** Price composition by tax rate. */
|
|
389
232
|
totalPriceGrossByTaxRate?: GrossPriceComponentDto[] | undefined;
|
|
390
|
-
/** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
|
|
391
233
|
ignoreChildPriceUpdates: boolean;
|
|
392
|
-
/** Net price after applied deductions. */
|
|
393
234
|
readonly deductedPrice: number;
|
|
394
|
-
/** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
|
|
395
235
|
deductionFactor: number;
|
|
396
|
-
/** The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum. */
|
|
397
236
|
absoluteDeduction?: number | undefined;
|
|
398
|
-
/** Will return this ElementContainerBase's total price. */
|
|
399
237
|
readonly totalPrice: number;
|
|
400
|
-
/** The total gross price for this ElementContainerBase including all child elements. */
|
|
401
238
|
readonly totalPriceGross: number;
|
|
402
|
-
/** Total gross price after applied deductions. */
|
|
403
239
|
readonly totalPriceGrossDeducted: number;
|
|
404
|
-
|
|
405
|
-
priceType: PriceTypeDto;
|
|
406
|
-
/** Information about the bidder. */
|
|
240
|
+
priceType?: PriceTypeDto | undefined;
|
|
407
241
|
bidder?: PartyInformationDto | undefined;
|
|
408
|
-
/** This discriminator is used to identify different bidders in a project. It is different from the Identifier property in the Bidder in that the BidderDiscriminator is intended to be a numerical identifier within a project, while the Identifier does uniquely identify a bidder in the system independent of a specific project. This property should map to "Bieternummer" or "BidderNo" in GAEB. */
|
|
409
242
|
bidderDiscriminator?: string | undefined;
|
|
410
|
-
/** This is used to store the GAEB XML Id within this ServiceSpecification. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
411
243
|
gaebXmlId?: string | undefined;
|
|
412
|
-
/** The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project. */
|
|
413
244
|
readonly projectInformation?: ProjectInformationDto | undefined;
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
/** This indicates where the service specification originates, i.e. from an exchange file format or self created. If applicable, additional information is present in the OriginDetail property. */
|
|
417
|
-
origin: OriginDto;
|
|
418
|
-
/** This property complements the Origin property. Some formats, e.g. GaebXml might have additional information attached, e.g. GAEB XML V3.2 oder GAEB XML V3.1. This string property is used to hold such data. The Dangl.AVA module does not have a list of possible values, since this is defined in the native format assemblies, e.g. Dangl.GAEB or Dangl.Oenorm. */
|
|
245
|
+
exchangePhase?: ExchangePhaseDto | undefined;
|
|
246
|
+
origin?: OriginDto | undefined;
|
|
419
247
|
originDetail?: string | undefined;
|
|
420
|
-
|
|
248
|
+
originSystem?: string | undefined;
|
|
249
|
+
originApplication?: string | undefined;
|
|
250
|
+
originVersion?: string | undefined;
|
|
421
251
|
creationDate?: Date | undefined;
|
|
422
|
-
/** Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" */
|
|
423
252
|
offerByDate?: Date | undefined;
|
|
424
|
-
/** Date indicating by when the buyer will select a contractor. */
|
|
425
253
|
decisionDate?: Date | undefined;
|
|
426
|
-
/** Date of when the offer / bid was created */
|
|
427
254
|
bidDate?: Date | undefined;
|
|
428
|
-
/** If a construction project requires a warranty bond, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as a warranty bond. */
|
|
429
255
|
warrantyBondPercentage: number;
|
|
430
|
-
/** If a construction project requires an execution guarantty, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as an execution guarantee. In practice, this percentage is usually deducted from intermediate invoices and only billed in the final invoice. */
|
|
431
256
|
executionGuaranteePercentage: number;
|
|
432
|
-
/** String indicating where the physical submission of the offer is taking place. */
|
|
433
257
|
submissionLocation?: string | undefined;
|
|
434
|
-
/** Description of this ServiceSpecification. */
|
|
435
258
|
description?: string | undefined;
|
|
436
|
-
/** The name of this ServiceSpecification. */
|
|
437
259
|
name?: string | undefined;
|
|
438
|
-
/** This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. */
|
|
439
260
|
priceInformation?: PriceInformationDto | undefined;
|
|
440
|
-
/** These are Catalogue that are used within this ElementContainerBase. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
441
261
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
442
|
-
/** Referenced catalogues for this ElementContainerBase. */
|
|
443
262
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
444
|
-
/** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
|
|
445
263
|
sustainabilityCatalogues?: SustainabilityCatalogueDto[] | undefined;
|
|
446
|
-
/** The date when the execution of the services is scheduled to start */
|
|
447
264
|
plannedExecutionStart?: Date | undefined;
|
|
448
|
-
/** The date then the execution of the services is scheduled to be finished */
|
|
449
265
|
plannedExecutionEnd?: Date | undefined;
|
|
450
|
-
/** The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB */
|
|
451
266
|
contractDate?: Date | undefined;
|
|
452
|
-
/** This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB */
|
|
453
267
|
contractIdentifier?: string | undefined;
|
|
454
|
-
/** This indicates how long the warranty period is for this ServiceSpecification */
|
|
455
268
|
warrantyDuration?: WarrantyDurationDto | undefined;
|
|
456
|
-
/** The date on which the warranty period ends */
|
|
457
269
|
warrantyEnd?: Date | undefined;
|
|
458
|
-
/** The date on which the services rendered by the bidder are scheduled to be approved by the buyer */
|
|
459
270
|
approvalDate?: Date | undefined;
|
|
460
|
-
/** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
|
|
461
271
|
typeOfApproval?: string | undefined;
|
|
462
|
-
/** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
|
|
463
272
|
addendumNumber?: string | undefined;
|
|
464
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
465
273
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
466
|
-
/** This property holds additional information that's only valid in commerce exchange phases. */
|
|
467
274
|
commerceProperties?: ServiceSpecificationCommercePropertiesDto | undefined;
|
|
468
275
|
constructor(data?: IServiceSpecificationDto);
|
|
469
276
|
init?(_data?: any): void;
|
|
470
277
|
static fromJS(data: any): ServiceSpecificationDto;
|
|
471
278
|
toJSON?(data?: any): any;
|
|
472
279
|
}
|
|
473
|
-
/** This is the base class that holds information about a whole service specification. */
|
|
474
280
|
interface IServiceSpecificationDto {
|
|
475
|
-
/** Elements GUID identifier. */
|
|
476
281
|
id: string;
|
|
477
|
-
/** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
478
282
|
projectHourlyWage: number;
|
|
479
|
-
/** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
480
283
|
projectTaxRate: number;
|
|
481
|
-
/** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
|
|
482
284
|
projectPriceComponents?: string[] | undefined;
|
|
483
|
-
/** The ItemNumberSchema that is used within this project. */
|
|
484
285
|
projectItemNumberSchema?: IItemNumberSchemaDto | undefined;
|
|
485
|
-
/** The IElements within this ElementContainerBase. */
|
|
486
286
|
elements?: IElementDto[] | undefined;
|
|
487
|
-
/** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
|
|
488
287
|
projectLabourTimeLabel?: string | undefined;
|
|
489
|
-
/** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
490
288
|
containsDuplicateItemNumbers: boolean;
|
|
491
|
-
/** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
492
289
|
containsDuplicateElementIds: boolean;
|
|
493
|
-
/** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
494
290
|
ignoreDuplicateItemNumbers: boolean;
|
|
495
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
|
|
496
291
|
ignoreProjectCataloguePropagation: boolean;
|
|
497
|
-
/** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
498
292
|
ignoreDuplicateElementIds: boolean;
|
|
499
|
-
/** Price composition by tax rate. */
|
|
500
293
|
totalPriceGrossByTaxRate?: IGrossPriceComponentDto[] | undefined;
|
|
501
|
-
/** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
|
|
502
294
|
ignoreChildPriceUpdates: boolean;
|
|
503
|
-
/** Net price after applied deductions. */
|
|
504
295
|
deductedPrice: number;
|
|
505
|
-
/** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
|
|
506
296
|
deductionFactor: number;
|
|
507
|
-
/** The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum. */
|
|
508
297
|
absoluteDeduction?: number | undefined;
|
|
509
|
-
/** Will return this ElementContainerBase's total price. */
|
|
510
298
|
totalPrice: number;
|
|
511
|
-
/** The total gross price for this ElementContainerBase including all child elements. */
|
|
512
299
|
totalPriceGross: number;
|
|
513
|
-
/** Total gross price after applied deductions. */
|
|
514
300
|
totalPriceGrossDeducted: number;
|
|
515
|
-
|
|
516
|
-
priceType: PriceTypeDto;
|
|
517
|
-
/** Information about the bidder. */
|
|
301
|
+
priceType?: PriceTypeDto | undefined;
|
|
518
302
|
bidder?: IPartyInformationDto | undefined;
|
|
519
|
-
/** This discriminator is used to identify different bidders in a project. It is different from the Identifier property in the Bidder in that the BidderDiscriminator is intended to be a numerical identifier within a project, while the Identifier does uniquely identify a bidder in the system independent of a specific project. This property should map to "Bieternummer" or "BidderNo" in GAEB. */
|
|
520
303
|
bidderDiscriminator?: string | undefined;
|
|
521
|
-
/** This is used to store the GAEB XML Id within this ServiceSpecification. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
522
304
|
gaebXmlId?: string | undefined;
|
|
523
|
-
/** The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project. */
|
|
524
305
|
projectInformation?: IProjectInformationDto | undefined;
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
/** This indicates where the service specification originates, i.e. from an exchange file format or self created. If applicable, additional information is present in the OriginDetail property. */
|
|
528
|
-
origin: OriginDto;
|
|
529
|
-
/** This property complements the Origin property. Some formats, e.g. GaebXml might have additional information attached, e.g. GAEB XML V3.2 oder GAEB XML V3.1. This string property is used to hold such data. The Dangl.AVA module does not have a list of possible values, since this is defined in the native format assemblies, e.g. Dangl.GAEB or Dangl.Oenorm. */
|
|
306
|
+
exchangePhase?: ExchangePhaseDto | undefined;
|
|
307
|
+
origin?: OriginDto | undefined;
|
|
530
308
|
originDetail?: string | undefined;
|
|
531
|
-
|
|
309
|
+
originSystem?: string | undefined;
|
|
310
|
+
originApplication?: string | undefined;
|
|
311
|
+
originVersion?: string | undefined;
|
|
532
312
|
creationDate?: Date | undefined;
|
|
533
|
-
/** Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" */
|
|
534
313
|
offerByDate?: Date | undefined;
|
|
535
|
-
/** Date indicating by when the buyer will select a contractor. */
|
|
536
314
|
decisionDate?: Date | undefined;
|
|
537
|
-
/** Date of when the offer / bid was created */
|
|
538
315
|
bidDate?: Date | undefined;
|
|
539
|
-
/** If a construction project requires a warranty bond, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as a warranty bond. */
|
|
540
316
|
warrantyBondPercentage: number;
|
|
541
|
-
/** If a construction project requires an execution guarantty, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as an execution guarantee. In practice, this percentage is usually deducted from intermediate invoices and only billed in the final invoice. */
|
|
542
317
|
executionGuaranteePercentage: number;
|
|
543
|
-
/** String indicating where the physical submission of the offer is taking place. */
|
|
544
318
|
submissionLocation?: string | undefined;
|
|
545
|
-
/** Description of this ServiceSpecification. */
|
|
546
319
|
description?: string | undefined;
|
|
547
|
-
/** The name of this ServiceSpecification. */
|
|
548
320
|
name?: string | undefined;
|
|
549
|
-
/** This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. */
|
|
550
321
|
priceInformation?: IPriceInformationDto | undefined;
|
|
551
|
-
/** These are Catalogue that are used within this ElementContainerBase. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
552
322
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
553
|
-
/** Referenced catalogues for this ElementContainerBase. */
|
|
554
323
|
catalogueReferences?: ICatalogueReferenceDto[] | undefined;
|
|
555
|
-
/** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
|
|
556
324
|
sustainabilityCatalogues?: ISustainabilityCatalogueDto[] | undefined;
|
|
557
|
-
/** The date when the execution of the services is scheduled to start */
|
|
558
325
|
plannedExecutionStart?: Date | undefined;
|
|
559
|
-
/** The date then the execution of the services is scheduled to be finished */
|
|
560
326
|
plannedExecutionEnd?: Date | undefined;
|
|
561
|
-
/** The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB */
|
|
562
327
|
contractDate?: Date | undefined;
|
|
563
|
-
/** This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB */
|
|
564
328
|
contractIdentifier?: string | undefined;
|
|
565
|
-
/** This indicates how long the warranty period is for this ServiceSpecification */
|
|
566
329
|
warrantyDuration?: IWarrantyDurationDto | undefined;
|
|
567
|
-
/** The date on which the warranty period ends */
|
|
568
330
|
warrantyEnd?: Date | undefined;
|
|
569
|
-
/** The date on which the services rendered by the bidder are scheduled to be approved by the buyer */
|
|
570
331
|
approvalDate?: Date | undefined;
|
|
571
|
-
/** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
|
|
572
332
|
typeOfApproval?: string | undefined;
|
|
573
|
-
/** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
|
|
574
333
|
addendumNumber?: string | undefined;
|
|
575
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
576
334
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
577
|
-
/** This property holds additional information that's only valid in commerce exchange phases. */
|
|
578
335
|
commerceProperties?: IServiceSpecificationCommercePropertiesDto | undefined;
|
|
579
336
|
}
|
|
580
|
-
/** Base interface definition for elements within an ElementContainerBase. */
|
|
581
337
|
declare abstract class IElementDto implements IIElementDto {
|
|
582
338
|
elementType: string;
|
|
583
339
|
elementTypeDiscriminator: string;
|
|
584
|
-
/** Elements GUID identifier. */
|
|
585
340
|
id: string;
|
|
586
|
-
/** This is used to store the GAEB XML Id within this IElement. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
587
341
|
gaebXmlId?: string | undefined;
|
|
588
|
-
/** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
|
|
589
342
|
addendumNumber?: string | undefined;
|
|
590
343
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
591
344
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
@@ -595,54 +348,35 @@ declare abstract class IElementDto implements IIElementDto {
|
|
|
595
348
|
static fromJS(data: any): IElementDto;
|
|
596
349
|
toJSON?(data?: any): any;
|
|
597
350
|
}
|
|
598
|
-
/** Base interface definition for elements within an ElementContainerBase. */
|
|
599
351
|
interface IIElementDto {
|
|
600
352
|
elementType: string;
|
|
601
353
|
elementTypeDiscriminator: string;
|
|
602
|
-
/** Elements GUID identifier. */
|
|
603
354
|
id: string;
|
|
604
|
-
/** This is used to store the GAEB XML Id within this IElement. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
605
355
|
gaebXmlId?: string | undefined;
|
|
606
|
-
/** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
|
|
607
356
|
addendumNumber?: string | undefined;
|
|
608
357
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
609
358
|
catalogueReferences?: ICatalogueReferenceDto[] | undefined;
|
|
610
359
|
}
|
|
611
|
-
/** This class describes an external catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
|
|
612
360
|
declare class CatalogueDto implements ICatalogueDto {
|
|
613
|
-
/** Elements GUID identifier. */
|
|
614
361
|
id: string;
|
|
615
|
-
/** This is used to store the GAEB XML Id within this Catalogue. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
616
362
|
gaebXmlId?: string | undefined;
|
|
617
|
-
/** The name that is given for this catalogue. */
|
|
618
363
|
name?: string | undefined;
|
|
619
|
-
/** Additional information about this catalogue. */
|
|
620
364
|
description?: string | undefined;
|
|
621
|
-
|
|
622
|
-
catalogueType: CatalogueTypeDto;
|
|
623
|
-
/** This property may hold additional information about the catalogue type. It is currently only used in GAEB XML exchange to carry detailed information about a catalogue type, but it's otherwise just a free text field. */
|
|
365
|
+
catalogueType?: CatalogueTypeDto | undefined;
|
|
624
366
|
catalogueTypeDetail?: string | undefined;
|
|
625
367
|
constructor(data?: ICatalogueDto);
|
|
626
368
|
init?(_data?: any): void;
|
|
627
369
|
static fromJS(data: any): CatalogueDto;
|
|
628
370
|
toJSON?(data?: any): any;
|
|
629
371
|
}
|
|
630
|
-
/** This class describes an external catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
|
|
631
372
|
interface ICatalogueDto {
|
|
632
|
-
/** Elements GUID identifier. */
|
|
633
373
|
id: string;
|
|
634
|
-
/** This is used to store the GAEB XML Id within this Catalogue. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
635
374
|
gaebXmlId?: string | undefined;
|
|
636
|
-
/** The name that is given for this catalogue. */
|
|
637
375
|
name?: string | undefined;
|
|
638
|
-
/** Additional information about this catalogue. */
|
|
639
376
|
description?: string | undefined;
|
|
640
|
-
|
|
641
|
-
catalogueType: CatalogueTypeDto;
|
|
642
|
-
/** This property may hold additional information about the catalogue type. It is currently only used in GAEB XML exchange to carry detailed information about a catalogue type, but it's otherwise just a free text field. */
|
|
377
|
+
catalogueType?: CatalogueTypeDto | undefined;
|
|
643
378
|
catalogueTypeDetail?: string | undefined;
|
|
644
379
|
}
|
|
645
|
-
/** This enumeration describes the type of a catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
|
|
646
380
|
declare enum CatalogueTypeDto {
|
|
647
381
|
Unknown = "Unknown",
|
|
648
382
|
Location = "Location",
|
|
@@ -653,678 +387,432 @@ declare enum CatalogueTypeDto {
|
|
|
653
387
|
BIM = "BIM",
|
|
654
388
|
Attachment = "Attachment"
|
|
655
389
|
}
|
|
656
|
-
/** This class is used to link data between catalogues and objects. */
|
|
657
390
|
declare class CatalogueReferenceDto implements ICatalogueReferenceDto {
|
|
658
|
-
/** Elements GUID identifier. */
|
|
659
391
|
id: string;
|
|
660
|
-
/** This points to the item in the catalogue itself. This means that, for example when this quantity assignment references a "DIN 276" catalogue, this property indicates the number / identifier / key in DIN 276 that is referenced. */
|
|
661
392
|
catalogueReferenceKey?: string | undefined;
|
|
662
|
-
/** The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue. */
|
|
663
393
|
catalogueReferenceId: string;
|
|
664
|
-
/** These are CatalogueReference that are used within this ServiceSpecification. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
665
394
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
666
|
-
/** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
|
|
667
395
|
readonly catalogue?: CatalogueDto | undefined;
|
|
668
396
|
constructor(data?: ICatalogueReferenceDto);
|
|
669
397
|
init?(_data?: any): void;
|
|
670
398
|
static fromJS(data: any): CatalogueReferenceDto;
|
|
671
399
|
toJSON?(data?: any): any;
|
|
672
400
|
}
|
|
673
|
-
/** This class is used to link data between catalogues and objects. */
|
|
674
401
|
interface ICatalogueReferenceDto {
|
|
675
|
-
/** Elements GUID identifier. */
|
|
676
402
|
id: string;
|
|
677
|
-
/** This points to the item in the catalogue itself. This means that, for example when this quantity assignment references a "DIN 276" catalogue, this property indicates the number / identifier / key in DIN 276 that is referenced. */
|
|
678
403
|
catalogueReferenceKey?: string | undefined;
|
|
679
|
-
/** The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue. */
|
|
680
404
|
catalogueReferenceId: string;
|
|
681
|
-
/** These are CatalogueReference that are used within this ServiceSpecification. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
682
405
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
683
|
-
/** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
|
|
684
406
|
catalogue?: ICatalogueDto | undefined;
|
|
685
407
|
}
|
|
686
|
-
/** A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc. */
|
|
687
408
|
declare class PositionDto extends IElementDto implements IPositionDto {
|
|
688
|
-
/** Will return the price per unit, rounded according to the project settings or the default value of three decimal places */
|
|
689
409
|
readonly unitPrice: number;
|
|
690
|
-
/** You can use this property to directly set the unit price for this position. This will
|
|
410
|
+
/** You can use this property to directly set the unit price for this position. This will
|
|
411
|
+
override any given PriceComponents */
|
|
691
412
|
unitPriceOverride?: number | undefined;
|
|
692
|
-
/** Will return this Position's total quantity, rounded to three decimal places. */
|
|
693
413
|
readonly quantity: number;
|
|
694
|
-
/** You can use this property to directly set the quantity for this position. This will
|
|
414
|
+
/** You can use this property to directly set the quantity for this position. This will
|
|
415
|
+
override any given QuantityComponents */
|
|
695
416
|
quantityOverride?: number | undefined;
|
|
696
|
-
/** This indicates true if this specific position is specified as a complementing position
|
|
417
|
+
/** This indicates true if this specific position is specified as a complementing position
|
|
418
|
+
for any base position. */
|
|
697
419
|
isComplementingPosition: boolean;
|
|
698
|
-
/** If IsComplementingPosition is set to true, this will indicate which base
|
|
420
|
+
/** If IsComplementingPosition is set to true, this will indicate which base
|
|
421
|
+
positions are targeted by this complementing position. */
|
|
699
422
|
complementsPositions?: string[] | undefined;
|
|
700
|
-
/** You can use this property to directly specify the total price of this position as a
|
|
423
|
+
/** You can use this property to directly specify the total price of this position as a
|
|
424
|
+
percentage of the sum of the total prices of base positions that this position
|
|
425
|
+
complements. It will essentially set the total price for this position to the sum of all
|
|
426
|
+
total prices of the positions specified in ComplementsPositions multiplied
|
|
427
|
+
by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
|
|
701
428
|
complementingPricePercentageOverride?: number | undefined;
|
|
702
|
-
/** This is a read only property showing the total price of this positions as a percentage
|
|
429
|
+
/** This is a read only property showing the total price of this positions as a percentage
|
|
430
|
+
of the sum of the total prices of all base positions, in case this position is a
|
|
431
|
+
complementing positions. If this position is not a complementing position, this will be
|
|
432
|
+
null. Also, if no prices are present, this will also be null. */
|
|
703
433
|
complementingPricePercentage?: number | undefined;
|
|
704
|
-
/** The tag of the unit used for this positions quantity. */
|
|
705
434
|
unitTag?: string | undefined;
|
|
706
|
-
/** The components for labour time in this Position. */
|
|
707
435
|
labourComponents?: LabourPriceComponentDto | undefined;
|
|
708
|
-
/** The single price components in this Position. Price components should not be handled directly on a per-position basis but set globally in the parent Projects ProjectInformation. */
|
|
709
436
|
priceComponents?: PriceComponentDto[] | undefined;
|
|
710
|
-
/** The quantity components of this Position. */
|
|
711
437
|
quantityComponents?: CalculationDto[] | undefined;
|
|
712
|
-
/** Further structuring of this Position. */
|
|
713
438
|
subDescriptions?: SubDescriptionDto[] | undefined;
|
|
714
|
-
|
|
715
|
-
comissionStatus: ComissionStatusDto;
|
|
716
|
-
/** A list of positions that complement this Position. The positions are referenced by their GUIDs. It might be used together with ComplementedByQuantities in case that only a given quantity is complemented by positions. */
|
|
439
|
+
comissionStatus?: ComissionStatusDto | undefined;
|
|
717
440
|
complementedBy?: string[] | undefined;
|
|
718
|
-
/** This list contains information about sustainability indicators or environmental impact for this position. */
|
|
719
441
|
sustainabilityIndicators?: PositionSustainabilityIndicatorDto[] | undefined;
|
|
720
|
-
/** Will indicate if this Position is complemented in this ServiceSpecification by other Positions. It can not be set to false when there are entries in the ComplementedBy property. */
|
|
721
442
|
complemented: boolean;
|
|
722
|
-
/** Indicates that the amount for this Position is to be set by the bidder. */
|
|
723
443
|
amountToBeEnteredByBidder: boolean;
|
|
724
|
-
/** Indicates if the bidder demands for prices to be broken up into their price components. */
|
|
725
444
|
priceCompositionRequired: boolean;
|
|
726
|
-
/** Indicates if this Position should use a different TaxRate than what is the default for the Project. */
|
|
727
445
|
useDifferentTaxRate: boolean;
|
|
728
|
-
/** Will return either the parent ServiceSpecification's TaxRate or it's own if it has a different value. (For example, in Germany Water has a different TaxRate than regular Positions) */
|
|
729
446
|
taxRate: number;
|
|
730
|
-
/** The ItemNumber for this Position. */
|
|
731
447
|
itemNumber?: ItemNumberDto | undefined;
|
|
732
|
-
/** The rate of deductions, i.e. 0.12m means 12% price deduction. */
|
|
733
448
|
deductionFactor: number;
|
|
734
|
-
/** Returns the product of UnitPrice times Quantity. */
|
|
735
449
|
readonly totalPrice: number;
|
|
736
|
-
/** The total gross price for this Position. */
|
|
737
450
|
readonly totalPriceGross: number;
|
|
738
|
-
/** Total gross price after applied deductions. */
|
|
739
451
|
readonly totalPriceGrossDeducted: number;
|
|
740
|
-
/** Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position. */
|
|
741
452
|
readonly deductedPrice: number;
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
priceType: PriceTypeDto;
|
|
746
|
-
/** This indicates if this position is regular or describing a labour / hourly paid work service */
|
|
747
|
-
serviceType: ServiceTypeDto;
|
|
748
|
-
/** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
|
|
453
|
+
positionType?: PositionTypeDto | undefined;
|
|
454
|
+
priceType?: PriceTypeDto | undefined;
|
|
455
|
+
serviceType?: ServiceTypeDto | undefined;
|
|
749
456
|
productData?: ProductDataDto | undefined;
|
|
750
|
-
/**
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
754
|
-
*/
|
|
457
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
458
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
459
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
755
460
|
shortText?: string | undefined;
|
|
756
|
-
/** This
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
760
|
-
*/
|
|
461
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
462
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
463
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
761
464
|
htmlShortText?: string | undefined;
|
|
762
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
763
465
|
longText?: string | undefined;
|
|
764
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
765
466
|
htmlLongText?: string | undefined;
|
|
766
|
-
|
|
767
|
-
additionType: AdditionTypeDto;
|
|
467
|
+
additionType?: AdditionTypeDto | undefined;
|
|
768
468
|
elementType: string;
|
|
769
469
|
elementTypeDiscriminator: string;
|
|
770
|
-
/** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of this Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes. */
|
|
771
470
|
quantityAssignments?: QuantityAssignmentDto[] | undefined;
|
|
772
|
-
/** The CommerceProperties support specialized information that is only useful in GAEB XML 9x data exchange phases. It is intended to provide article information. */
|
|
773
471
|
commerceProperties?: CommercePropertiesDto | undefined;
|
|
774
|
-
/** If this position is an Alternative, then this property should point to the id of the position in this service specification that it can replace. If this is set to a value, you can optionally also specify an identifier via AlternativeIdentifier to specifiy multiple positions that must be used together to be an alternative to a single base position. */
|
|
775
472
|
alternativeTo: string | undefined;
|
|
776
|
-
/** This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific position is assigned to. That way, if you specifiy multiple alternative Positions with the same AlternativeIdentifier, you can indicate that to replace a single base Position, multiple alternative Positions should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base position via AlternativeTo. */
|
|
777
473
|
alternativeIdentifier?: number | undefined;
|
|
778
|
-
/** This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific position is assigned to. That way, you can specify the id (in integer format) for the alternative group this position belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a position only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base position for a specific group. This was introduced in version v2.9.0 to be able to model both position and group ids for alternative group combinations. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base position via AlternativeTo. */
|
|
779
474
|
alternativeGroupIdentifier?: number | undefined;
|
|
780
|
-
/** If this is true, it indicates that the position is intended to be a lump sum, "Pauschal" in German. This means the position total price that is being invoiced should not depend on the actual quantity. In practice, partial invoices are still often used for partial services rendered. This property does not affect the price calculation for this position. Typically, the Quantity should be set to 1.0 when this flag is used. */
|
|
781
475
|
isLumpSum: boolean;
|
|
782
|
-
/** This identifier can be used to point to the Id of a position in the same ServiceSpecification that acts as a base position. It matches "Bezugsposition" in GAEB. This can be used for positions that repeat partially or are linked together */
|
|
783
476
|
repetitionTo: string | undefined;
|
|
784
477
|
v1CompatibilityPriceType?: string | undefined;
|
|
785
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
786
478
|
standardizedDescription?: StandardizedDescriptionDto | undefined;
|
|
787
|
-
/** This list contains references to positions that complement this one, additionally also specifying a quantity for which the addition is intended. This does not replace the ComplementedBy property and there are no automatic checks being done between these two properties, so it's up to the user code to ensure deletions (and additions, if desired) are performed for both properties. When copying withing keeping Ids, this list will not be part of the copy process, since it would only contain quantities without actual position references. Containers, however, will rebuild the list with updated position references when copying positions that contain entries here. */
|
|
788
479
|
complementedByQuantities?: ComplementedByQuantityDto[] | undefined;
|
|
789
|
-
/** This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions should be executed in practice. Often, the position itself still has text of its own to highlight deviations from that or add more details. */
|
|
790
480
|
executionDescriptionReference: string | undefined;
|
|
791
|
-
/** This indicates if a position has not been offered. This is typically only expected to be true when the exchange phase of the parent ServiceSpecification is Offer, and it means that the position has not been offered at all. */
|
|
792
481
|
notOffered: boolean;
|
|
793
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
|
|
794
482
|
oenormPositionProperties?: OenormPositionPropertiesDto | undefined;
|
|
795
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
796
483
|
descriptionId?: string | undefined;
|
|
797
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
798
484
|
hierarchyLevel: number;
|
|
799
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
800
485
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
801
486
|
readonly hasBidderCommentInHtmlLongText: boolean;
|
|
802
|
-
|
|
803
|
-
gaebComplementingType: PositionComplementingTypeDto;
|
|
804
|
-
/** HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site. */
|
|
487
|
+
gaebComplementingType?: PositionComplementingTypeDto | undefined;
|
|
805
488
|
holdOutProperties?: PositionHoldOutPropertiesDto | undefined;
|
|
806
|
-
/** This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations. */
|
|
807
489
|
estimatedQuantity?: number | undefined;
|
|
808
|
-
/** This is an optional property that holds price catalogue data. These are prices that may represent an estimate, and they typically come from a price catalogue. */
|
|
809
490
|
priceCatalogueData?: PriceCatalogueDataDto | undefined;
|
|
810
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties. */
|
|
811
491
|
ignoreProjectCataloguePropagation: boolean;
|
|
812
|
-
/** A main position means that this position is important and should be highlighted in the user interface. Important meaning that is is usually a bigger part of the total sum of the services, or it needs special attention in another way. */
|
|
813
492
|
isMainPosition: boolean;
|
|
814
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
815
493
|
baseCatalogueNumber?: string | undefined;
|
|
816
494
|
constructor(data?: IPositionDto);
|
|
817
495
|
init(_data?: any): void;
|
|
818
496
|
static fromJS(data: any): PositionDto;
|
|
819
497
|
toJSON(data?: any): any;
|
|
820
498
|
}
|
|
821
|
-
/** A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc. */
|
|
822
499
|
interface IPositionDto extends IIElementDto {
|
|
823
|
-
/** Will return the price per unit, rounded according to the project settings or the default value of three decimal places */
|
|
824
500
|
unitPrice: number;
|
|
825
|
-
/** You can use this property to directly set the unit price for this position. This will
|
|
501
|
+
/** You can use this property to directly set the unit price for this position. This will
|
|
502
|
+
override any given PriceComponents */
|
|
826
503
|
unitPriceOverride?: number | undefined;
|
|
827
|
-
/** Will return this Position's total quantity, rounded to three decimal places. */
|
|
828
504
|
quantity: number;
|
|
829
|
-
/** You can use this property to directly set the quantity for this position. This will
|
|
505
|
+
/** You can use this property to directly set the quantity for this position. This will
|
|
506
|
+
override any given QuantityComponents */
|
|
830
507
|
quantityOverride?: number | undefined;
|
|
831
|
-
/** This indicates true if this specific position is specified as a complementing position
|
|
508
|
+
/** This indicates true if this specific position is specified as a complementing position
|
|
509
|
+
for any base position. */
|
|
832
510
|
isComplementingPosition: boolean;
|
|
833
|
-
/** If IsComplementingPosition is set to true, this will indicate which base
|
|
511
|
+
/** If IsComplementingPosition is set to true, this will indicate which base
|
|
512
|
+
positions are targeted by this complementing position. */
|
|
834
513
|
complementsPositions?: string[] | undefined;
|
|
835
|
-
/** You can use this property to directly specify the total price of this position as a
|
|
514
|
+
/** You can use this property to directly specify the total price of this position as a
|
|
515
|
+
percentage of the sum of the total prices of base positions that this position
|
|
516
|
+
complements. It will essentially set the total price for this position to the sum of all
|
|
517
|
+
total prices of the positions specified in ComplementsPositions multiplied
|
|
518
|
+
by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
|
|
836
519
|
complementingPricePercentageOverride?: number | undefined;
|
|
837
|
-
/** This is a read only property showing the total price of this positions as a percentage
|
|
520
|
+
/** This is a read only property showing the total price of this positions as a percentage
|
|
521
|
+
of the sum of the total prices of all base positions, in case this position is a
|
|
522
|
+
complementing positions. If this position is not a complementing position, this will be
|
|
523
|
+
null. Also, if no prices are present, this will also be null. */
|
|
838
524
|
complementingPricePercentage?: number | undefined;
|
|
839
|
-
/** The tag of the unit used for this positions quantity. */
|
|
840
525
|
unitTag?: string | undefined;
|
|
841
|
-
/** The components for labour time in this Position. */
|
|
842
526
|
labourComponents?: ILabourPriceComponentDto | undefined;
|
|
843
|
-
/** The single price components in this Position. Price components should not be handled directly on a per-position basis but set globally in the parent Projects ProjectInformation. */
|
|
844
527
|
priceComponents?: IPriceComponentDto[] | undefined;
|
|
845
|
-
/** The quantity components of this Position. */
|
|
846
528
|
quantityComponents?: ICalculationDto[] | undefined;
|
|
847
|
-
/** Further structuring of this Position. */
|
|
848
529
|
subDescriptions?: ISubDescriptionDto[] | undefined;
|
|
849
|
-
|
|
850
|
-
comissionStatus: ComissionStatusDto;
|
|
851
|
-
/** A list of positions that complement this Position. The positions are referenced by their GUIDs. It might be used together with ComplementedByQuantities in case that only a given quantity is complemented by positions. */
|
|
530
|
+
comissionStatus?: ComissionStatusDto | undefined;
|
|
852
531
|
complementedBy?: string[] | undefined;
|
|
853
|
-
/** This list contains information about sustainability indicators or environmental impact for this position. */
|
|
854
532
|
sustainabilityIndicators?: IPositionSustainabilityIndicatorDto[] | undefined;
|
|
855
|
-
/** Will indicate if this Position is complemented in this ServiceSpecification by other Positions. It can not be set to false when there are entries in the ComplementedBy property. */
|
|
856
533
|
complemented: boolean;
|
|
857
|
-
/** Indicates that the amount for this Position is to be set by the bidder. */
|
|
858
534
|
amountToBeEnteredByBidder: boolean;
|
|
859
|
-
/** Indicates if the bidder demands for prices to be broken up into their price components. */
|
|
860
535
|
priceCompositionRequired: boolean;
|
|
861
|
-
/** Indicates if this Position should use a different TaxRate than what is the default for the Project. */
|
|
862
536
|
useDifferentTaxRate: boolean;
|
|
863
|
-
/** Will return either the parent ServiceSpecification's TaxRate or it's own if it has a different value. (For example, in Germany Water has a different TaxRate than regular Positions) */
|
|
864
537
|
taxRate: number;
|
|
865
|
-
/** The ItemNumber for this Position. */
|
|
866
538
|
itemNumber?: IItemNumberDto | undefined;
|
|
867
|
-
/** The rate of deductions, i.e. 0.12m means 12% price deduction. */
|
|
868
539
|
deductionFactor: number;
|
|
869
|
-
/** Returns the product of UnitPrice times Quantity. */
|
|
870
540
|
totalPrice: number;
|
|
871
|
-
/** The total gross price for this Position. */
|
|
872
541
|
totalPriceGross: number;
|
|
873
|
-
/** Total gross price after applied deductions. */
|
|
874
542
|
totalPriceGrossDeducted: number;
|
|
875
|
-
/** Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position. */
|
|
876
543
|
deductedPrice: number;
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
priceType: PriceTypeDto;
|
|
881
|
-
/** This indicates if this position is regular or describing a labour / hourly paid work service */
|
|
882
|
-
serviceType: ServiceTypeDto;
|
|
883
|
-
/** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
|
|
544
|
+
positionType?: PositionTypeDto | undefined;
|
|
545
|
+
priceType?: PriceTypeDto | undefined;
|
|
546
|
+
serviceType?: ServiceTypeDto | undefined;
|
|
884
547
|
productData?: IProductDataDto | undefined;
|
|
885
|
-
/**
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
889
|
-
*/
|
|
548
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
549
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
550
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
890
551
|
shortText?: string | undefined;
|
|
891
|
-
/** This
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
895
|
-
*/
|
|
552
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
553
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
554
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
896
555
|
htmlShortText?: string | undefined;
|
|
897
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
898
556
|
longText?: string | undefined;
|
|
899
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
900
557
|
htmlLongText?: string | undefined;
|
|
901
|
-
|
|
902
|
-
additionType: AdditionTypeDto;
|
|
558
|
+
additionType?: AdditionTypeDto | undefined;
|
|
903
559
|
elementType: string;
|
|
904
|
-
/** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of this Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes. */
|
|
905
560
|
quantityAssignments?: IQuantityAssignmentDto[] | undefined;
|
|
906
|
-
/** The CommerceProperties support specialized information that is only useful in GAEB XML 9x data exchange phases. It is intended to provide article information. */
|
|
907
561
|
commerceProperties?: ICommercePropertiesDto | undefined;
|
|
908
|
-
/** If this position is an Alternative, then this property should point to the id of the position in this service specification that it can replace. If this is set to a value, you can optionally also specify an identifier via AlternativeIdentifier to specifiy multiple positions that must be used together to be an alternative to a single base position. */
|
|
909
562
|
alternativeTo: string | undefined;
|
|
910
|
-
/** This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific position is assigned to. That way, if you specifiy multiple alternative Positions with the same AlternativeIdentifier, you can indicate that to replace a single base Position, multiple alternative Positions should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base position via AlternativeTo. */
|
|
911
563
|
alternativeIdentifier?: number | undefined;
|
|
912
|
-
/** This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific position is assigned to. That way, you can specify the id (in integer format) for the alternative group this position belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a position only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base position for a specific group. This was introduced in version v2.9.0 to be able to model both position and group ids for alternative group combinations. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base position via AlternativeTo. */
|
|
913
564
|
alternativeGroupIdentifier?: number | undefined;
|
|
914
|
-
/** If this is true, it indicates that the position is intended to be a lump sum, "Pauschal" in German. This means the position total price that is being invoiced should not depend on the actual quantity. In practice, partial invoices are still often used for partial services rendered. This property does not affect the price calculation for this position. Typically, the Quantity should be set to 1.0 when this flag is used. */
|
|
915
565
|
isLumpSum: boolean;
|
|
916
|
-
/** This identifier can be used to point to the Id of a position in the same ServiceSpecification that acts as a base position. It matches "Bezugsposition" in GAEB. This can be used for positions that repeat partially or are linked together */
|
|
917
566
|
repetitionTo: string | undefined;
|
|
918
567
|
v1CompatibilityPriceType?: string | undefined;
|
|
919
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
920
568
|
standardizedDescription?: IStandardizedDescriptionDto | undefined;
|
|
921
|
-
/** This list contains references to positions that complement this one, additionally also specifying a quantity for which the addition is intended. This does not replace the ComplementedBy property and there are no automatic checks being done between these two properties, so it's up to the user code to ensure deletions (and additions, if desired) are performed for both properties. When copying withing keeping Ids, this list will not be part of the copy process, since it would only contain quantities without actual position references. Containers, however, will rebuild the list with updated position references when copying positions that contain entries here. */
|
|
922
569
|
complementedByQuantities?: IComplementedByQuantityDto[] | undefined;
|
|
923
|
-
/** This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions should be executed in practice. Often, the position itself still has text of its own to highlight deviations from that or add more details. */
|
|
924
570
|
executionDescriptionReference: string | undefined;
|
|
925
|
-
/** This indicates if a position has not been offered. This is typically only expected to be true when the exchange phase of the parent ServiceSpecification is Offer, and it means that the position has not been offered at all. */
|
|
926
571
|
notOffered: boolean;
|
|
927
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
|
|
928
572
|
oenormPositionProperties?: IOenormPositionPropertiesDto | undefined;
|
|
929
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
930
573
|
descriptionId?: string | undefined;
|
|
931
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
932
574
|
hierarchyLevel: number;
|
|
933
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
934
575
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
935
576
|
hasBidderCommentInHtmlLongText: boolean;
|
|
936
|
-
|
|
937
|
-
gaebComplementingType: PositionComplementingTypeDto;
|
|
938
|
-
/** HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site. */
|
|
577
|
+
gaebComplementingType?: PositionComplementingTypeDto | undefined;
|
|
939
578
|
holdOutProperties?: IPositionHoldOutPropertiesDto | undefined;
|
|
940
|
-
/** This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations. */
|
|
941
579
|
estimatedQuantity?: number | undefined;
|
|
942
|
-
/** This is an optional property that holds price catalogue data. These are prices that may represent an estimate, and they typically come from a price catalogue. */
|
|
943
580
|
priceCatalogueData?: IPriceCatalogueDataDto | undefined;
|
|
944
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties. */
|
|
945
581
|
ignoreProjectCataloguePropagation: boolean;
|
|
946
|
-
/** A main position means that this position is important and should be highlighted in the user interface. Important meaning that is is usually a bigger part of the total sum of the services, or it needs special attention in another way. */
|
|
947
582
|
isMainPosition: boolean;
|
|
948
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
949
583
|
baseCatalogueNumber?: string | undefined;
|
|
950
584
|
}
|
|
951
|
-
/** Based on the PriceComponent, this class is responsible for labour time components. */
|
|
952
585
|
declare class LabourPriceComponentDto implements ILabourPriceComponentDto {
|
|
953
|
-
/** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
|
|
954
586
|
label?: string | undefined;
|
|
955
|
-
/** The total, calculated price of this component. Will multiply the calculated amount of hours with the ServiceSpecifications hourly wage rate. */
|
|
956
587
|
readonly price: number;
|
|
957
|
-
/** The cost per hour of manual labor. */
|
|
958
588
|
hourlyWage: number;
|
|
959
|
-
/** The single Calculation elements this price component is composed of. */
|
|
960
589
|
values?: CalculationDto[] | undefined;
|
|
961
|
-
/** Indicates if the ServiceSpecification's standard HourlyWage is to be used or a custom value. */
|
|
962
590
|
useOwnHourlyWage: boolean;
|
|
963
|
-
/** The total, calculated time of this component. Will return the result rounded to three decimal places. */
|
|
964
591
|
readonly totalTime: number;
|
|
965
|
-
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
966
592
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
967
593
|
constructor(data?: ILabourPriceComponentDto);
|
|
968
594
|
init?(_data?: any): void;
|
|
969
595
|
static fromJS(data: any): LabourPriceComponentDto;
|
|
970
596
|
toJSON?(data?: any): any;
|
|
971
597
|
}
|
|
972
|
-
/** Based on the PriceComponent, this class is responsible for labour time components. */
|
|
973
598
|
interface ILabourPriceComponentDto {
|
|
974
|
-
/** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
|
|
975
599
|
label?: string | undefined;
|
|
976
|
-
/** The total, calculated price of this component. Will multiply the calculated amount of hours with the ServiceSpecifications hourly wage rate. */
|
|
977
600
|
price: number;
|
|
978
|
-
/** The cost per hour of manual labor. */
|
|
979
601
|
hourlyWage: number;
|
|
980
|
-
/** The single Calculation elements this price component is composed of. */
|
|
981
602
|
values?: ICalculationDto[] | undefined;
|
|
982
|
-
/** Indicates if the ServiceSpecification's standard HourlyWage is to be used or a custom value. */
|
|
983
603
|
useOwnHourlyWage: boolean;
|
|
984
|
-
/** The total, calculated time of this component. Will return the result rounded to three decimal places. */
|
|
985
604
|
totalTime: number;
|
|
986
|
-
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
987
605
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
988
606
|
}
|
|
989
|
-
/** This class holds means to calculate mathematical expressions from given strings. */
|
|
990
607
|
declare class CalculationDto implements ICalculationDto {
|
|
991
|
-
/** Descriptive text for this calculation. */
|
|
992
608
|
description?: string | undefined;
|
|
993
|
-
/** This Calculation's mathematical expression. Please note that thousands separators are not supported. Both comma and point will be treated as decimal separators. */
|
|
994
609
|
formula?: string | undefined;
|
|
995
|
-
/** The calculated result from the formula, 0 if invalid. */
|
|
996
610
|
readonly result: number;
|
|
997
|
-
/** Whether the Formula is a valid expression. */
|
|
998
611
|
readonly valid: boolean;
|
|
999
|
-
/** Will be -1 if the Formula is correct, else it will show the position in the formula where an error was encountered. This is a zero based index. */
|
|
1000
612
|
readonly errorPositionInLine: number;
|
|
1001
|
-
/** These are Catalogues that are used within this Calculation. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1002
613
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
1003
|
-
/** Referenced catalogues for this Calculation. */
|
|
1004
614
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
1005
615
|
constructor(data?: ICalculationDto);
|
|
1006
616
|
init?(_data?: any): void;
|
|
1007
617
|
static fromJS(data: any): CalculationDto;
|
|
1008
618
|
toJSON?(data?: any): any;
|
|
1009
619
|
}
|
|
1010
|
-
/** This class holds means to calculate mathematical expressions from given strings. */
|
|
1011
620
|
interface ICalculationDto {
|
|
1012
|
-
/** Descriptive text for this calculation. */
|
|
1013
621
|
description?: string | undefined;
|
|
1014
|
-
/** This Calculation's mathematical expression. Please note that thousands separators are not supported. Both comma and point will be treated as decimal separators. */
|
|
1015
622
|
formula?: string | undefined;
|
|
1016
|
-
/** The calculated result from the formula, 0 if invalid. */
|
|
1017
623
|
result: number;
|
|
1018
|
-
/** Whether the Formula is a valid expression. */
|
|
1019
624
|
valid: boolean;
|
|
1020
|
-
/** Will be -1 if the Formula is correct, else it will show the position in the formula where an error was encountered. This is a zero based index. */
|
|
1021
625
|
errorPositionInLine: number;
|
|
1022
|
-
/** These are Catalogues that are used within this Calculation. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1023
626
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
1024
|
-
/** Referenced catalogues for this Calculation. */
|
|
1025
627
|
catalogueReferences?: ICatalogueReferenceDto[] | undefined;
|
|
1026
628
|
}
|
|
1027
|
-
/** This class provides means to store information about a price and it's composition. Note that this is referencing to a single price component, so for example a Position would have a list of PriceComponents, one for Material, one for Labour etc. */
|
|
1028
629
|
declare class PriceComponentDto implements IPriceComponentDto {
|
|
1029
|
-
/** The total, calculated price of this component. */
|
|
1030
630
|
readonly price: number;
|
|
1031
|
-
/** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
|
|
1032
631
|
label?: string | undefined;
|
|
1033
|
-
/** The single Calculation elements this price component is composed of. */
|
|
1034
632
|
values?: CalculationDto[] | undefined;
|
|
1035
|
-
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1036
633
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
1037
634
|
constructor(data?: IPriceComponentDto);
|
|
1038
635
|
init?(_data?: any): void;
|
|
1039
636
|
static fromJS(data: any): PriceComponentDto;
|
|
1040
637
|
toJSON?(data?: any): any;
|
|
1041
638
|
}
|
|
1042
|
-
/** This class provides means to store information about a price and it's composition. Note that this is referencing to a single price component, so for example a Position would have a list of PriceComponents, one for Material, one for Labour etc. */
|
|
1043
639
|
interface IPriceComponentDto {
|
|
1044
|
-
/** The total, calculated price of this component. */
|
|
1045
640
|
price: number;
|
|
1046
|
-
/** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
|
|
1047
641
|
label?: string | undefined;
|
|
1048
|
-
/** The single Calculation elements this price component is composed of. */
|
|
1049
642
|
values?: ICalculationDto[] | undefined;
|
|
1050
|
-
/** These are Catalogues that are used within this PriceComponent. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1051
643
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
1052
644
|
}
|
|
1053
|
-
/** This is appended to a Position and is used to separate the complete Position into smaller amounts to be described separately, for example concrete walls could be attached to different building storeys. */
|
|
1054
645
|
declare class SubDescriptionDto implements ISubDescriptionDto {
|
|
1055
|
-
/** Elements GUID identifier. */
|
|
1056
646
|
id: string;
|
|
1057
|
-
/** Returns the total calculated sum of all quantity assignments. Will return the result rounded to three decimal places. */
|
|
1058
647
|
readonly quantity: number;
|
|
1059
|
-
/** You can use this property to directly set the quantity for this
|
|
648
|
+
/** You can use this property to directly set the quantity for this
|
|
649
|
+
sub description. This will override any given QuantityComponents */
|
|
1060
650
|
quantityOverride?: number | undefined;
|
|
1061
|
-
/** Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components. */
|
|
1062
651
|
quantityComponents?: CalculationDto[] | undefined;
|
|
1063
|
-
/** Indicates if the bidder is asked to specify an amount. */
|
|
1064
652
|
amountToBeEnteredByBidder: boolean;
|
|
1065
|
-
/** Identifier for this SubDescription. */
|
|
1066
653
|
identifier?: string | undefined;
|
|
1067
|
-
/**
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
1071
|
-
*/
|
|
654
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
655
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
656
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
1072
657
|
shortText?: string | undefined;
|
|
1073
|
-
/** This
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
1077
|
-
*/
|
|
658
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
659
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
660
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
1078
661
|
htmlShortText?: string | undefined;
|
|
1079
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1080
662
|
longText?: string | undefined;
|
|
1081
|
-
/** If this is given, then the sub description has a different unit tag than the parent position. */
|
|
1082
663
|
unitTag?: string | undefined;
|
|
1083
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1084
664
|
htmlLongText?: string | undefined;
|
|
1085
|
-
|
|
1086
|
-
additionType: AdditionTypeDto;
|
|
1087
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
665
|
+
additionType?: AdditionTypeDto | undefined;
|
|
1088
666
|
standardizedDescription?: StandardizedDescriptionDto | undefined;
|
|
1089
|
-
/** This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions (or sub descriptions) should be executed in practice. Often, the position (or sub description) itself still has text of its own to highlight deviations from that or add more details. When working with import and export features, this property is only supported in GAEB 90 data exchange. */
|
|
1090
667
|
executionDescriptionReference: string | undefined;
|
|
1091
|
-
/** These are Catalogues that are used within this Calculation. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1092
668
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
1093
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
1094
669
|
descriptionId?: string | undefined;
|
|
1095
670
|
readonly hasBidderCommentInHtmlLongText: boolean;
|
|
1096
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
1097
671
|
baseCatalogueNumber?: string | undefined;
|
|
1098
672
|
constructor(data?: ISubDescriptionDto);
|
|
1099
673
|
init?(_data?: any): void;
|
|
1100
674
|
static fromJS(data: any): SubDescriptionDto;
|
|
1101
675
|
toJSON?(data?: any): any;
|
|
1102
676
|
}
|
|
1103
|
-
/** This is appended to a Position and is used to separate the complete Position into smaller amounts to be described separately, for example concrete walls could be attached to different building storeys. */
|
|
1104
677
|
interface ISubDescriptionDto {
|
|
1105
|
-
/** Elements GUID identifier. */
|
|
1106
678
|
id: string;
|
|
1107
|
-
/** Returns the total calculated sum of all quantity assignments. Will return the result rounded to three decimal places. */
|
|
1108
679
|
quantity: number;
|
|
1109
|
-
/** You can use this property to directly set the quantity for this
|
|
680
|
+
/** You can use this property to directly set the quantity for this
|
|
681
|
+
sub description. This will override any given QuantityComponents */
|
|
1110
682
|
quantityOverride?: number | undefined;
|
|
1111
|
-
/** Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components. */
|
|
1112
683
|
quantityComponents?: ICalculationDto[] | undefined;
|
|
1113
|
-
/** Indicates if the bidder is asked to specify an amount. */
|
|
1114
684
|
amountToBeEnteredByBidder: boolean;
|
|
1115
|
-
/** Identifier for this SubDescription. */
|
|
1116
685
|
identifier?: string | undefined;
|
|
1117
|
-
/**
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
1121
|
-
*/
|
|
686
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
687
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
688
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
1122
689
|
shortText?: string | undefined;
|
|
1123
|
-
/** This
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
1127
|
-
*/
|
|
690
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
691
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
692
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
1128
693
|
htmlShortText?: string | undefined;
|
|
1129
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1130
694
|
longText?: string | undefined;
|
|
1131
|
-
/** If this is given, then the sub description has a different unit tag than the parent position. */
|
|
1132
695
|
unitTag?: string | undefined;
|
|
1133
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1134
696
|
htmlLongText?: string | undefined;
|
|
1135
|
-
|
|
1136
|
-
additionType: AdditionTypeDto;
|
|
1137
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
697
|
+
additionType?: AdditionTypeDto | undefined;
|
|
1138
698
|
standardizedDescription?: IStandardizedDescriptionDto | undefined;
|
|
1139
|
-
/** This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions (or sub descriptions) should be executed in practice. Often, the position (or sub description) itself still has text of its own to highlight deviations from that or add more details. When working with import and export features, this property is only supported in GAEB 90 data exchange. */
|
|
1140
699
|
executionDescriptionReference: string | undefined;
|
|
1141
|
-
/** These are Catalogues that are used within this Calculation. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection. */
|
|
1142
700
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
1143
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
1144
701
|
descriptionId?: string | undefined;
|
|
1145
702
|
hasBidderCommentInHtmlLongText: boolean;
|
|
1146
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
1147
703
|
baseCatalogueNumber?: string | undefined;
|
|
1148
704
|
}
|
|
1149
|
-
/** Indicates the origin of an element. */
|
|
1150
705
|
declare enum AdditionTypeDto {
|
|
1151
706
|
None = "None",
|
|
1152
707
|
ByBuyer = "ByBuyer",
|
|
1153
708
|
ByBidder = "ByBidder"
|
|
1154
709
|
}
|
|
1155
|
-
/** This class represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
1156
710
|
declare class StandardizedDescriptionDto implements IStandardizedDescriptionDto {
|
|
1157
|
-
|
|
1158
|
-
standardReferenceType: StandardReferenceTypeDto;
|
|
1159
|
-
/** This string property is the identifier to map to the references standard. Its type is given in the StandardReferenceType */
|
|
711
|
+
standardReferenceType?: StandardReferenceTypeDto | undefined;
|
|
1160
712
|
standardReference?: string | undefined;
|
|
1161
|
-
/** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
|
|
1162
713
|
stlbReference?: STLBReferenceDto | undefined;
|
|
1163
714
|
constructor(data?: IStandardizedDescriptionDto);
|
|
1164
715
|
init?(_data?: any): void;
|
|
1165
716
|
static fromJS(data: any): StandardizedDescriptionDto;
|
|
1166
717
|
toJSON?(data?: any): any;
|
|
1167
718
|
}
|
|
1168
|
-
/** This class represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
1169
719
|
interface IStandardizedDescriptionDto {
|
|
1170
|
-
|
|
1171
|
-
standardReferenceType: StandardReferenceTypeDto;
|
|
1172
|
-
/** This string property is the identifier to map to the references standard. Its type is given in the StandardReferenceType */
|
|
720
|
+
standardReferenceType?: StandardReferenceTypeDto | undefined;
|
|
1173
721
|
standardReference?: string | undefined;
|
|
1174
|
-
/** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
|
|
1175
722
|
stlbReference?: ISTLBReferenceDto | undefined;
|
|
1176
723
|
}
|
|
1177
|
-
/** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
|
|
1178
724
|
declare enum StandardReferenceTypeDto {
|
|
1179
725
|
Unknown = "Unknown",
|
|
1180
726
|
StLB = "StLB",
|
|
1181
727
|
StLK = "StLK",
|
|
1182
728
|
STLBBauZ = "STLBBauZ"
|
|
1183
729
|
}
|
|
1184
|
-
/** This class represents a specialized reference to the German STLB "Standardleistungsbuch Bau". The STLB is a commercial offering and describes common services in the construction sector. When this is used, this describes the exact type of a service via a reference to this standard */
|
|
1185
730
|
declare class STLBReferenceDto implements ISTLBReferenceDto {
|
|
1186
|
-
/** The date of the STLB version. Typically, only the Year and Month are used */
|
|
1187
731
|
versionDate?: Date | undefined;
|
|
1188
|
-
/** The name of the catalogue within the STLB */
|
|
1189
732
|
catalogueName?: string | undefined;
|
|
1190
|
-
/** The name of the group in STLB */
|
|
1191
733
|
group?: string | undefined;
|
|
1192
|
-
/** The cost group this service is associated with */
|
|
1193
734
|
costGroup?: string | undefined;
|
|
1194
|
-
/** The service area (or type) in the STLB */
|
|
1195
735
|
serviceArea?: string | undefined;
|
|
1196
|
-
/** These keys may optionally be used to further reference multiple, specific items within the STLB */
|
|
1197
736
|
keys?: STLBKeyDto[] | undefined;
|
|
1198
737
|
constructor(data?: ISTLBReferenceDto);
|
|
1199
738
|
init?(_data?: any): void;
|
|
1200
739
|
static fromJS(data: any): STLBReferenceDto;
|
|
1201
740
|
toJSON?(data?: any): any;
|
|
1202
741
|
}
|
|
1203
|
-
/** This class represents a specialized reference to the German STLB "Standardleistungsbuch Bau". The STLB is a commercial offering and describes common services in the construction sector. When this is used, this describes the exact type of a service via a reference to this standard */
|
|
1204
742
|
interface ISTLBReferenceDto {
|
|
1205
|
-
/** The date of the STLB version. Typically, only the Year and Month are used */
|
|
1206
743
|
versionDate?: Date | undefined;
|
|
1207
|
-
/** The name of the catalogue within the STLB */
|
|
1208
744
|
catalogueName?: string | undefined;
|
|
1209
|
-
/** The name of the group in STLB */
|
|
1210
745
|
group?: string | undefined;
|
|
1211
|
-
/** The cost group this service is associated with */
|
|
1212
746
|
costGroup?: string | undefined;
|
|
1213
|
-
/** The service area (or type) in the STLB */
|
|
1214
747
|
serviceArea?: string | undefined;
|
|
1215
|
-
/** These keys may optionally be used to further reference multiple, specific items within the STLB */
|
|
1216
748
|
keys?: ISTLBKeyDto[] | undefined;
|
|
1217
749
|
}
|
|
1218
|
-
/** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
|
|
1219
750
|
declare class STLBKeyDto implements ISTLBKeyDto {
|
|
1220
|
-
/** This identifier is required and uniquely describes a single reference within the STLB standard. It maps to "ArtChrIdent" in GAEB XML */
|
|
1221
751
|
artIdentifier: number;
|
|
1222
|
-
/** This optional index property further categorizes a single reference within the STLB standard. It maps to "ArtChIdx" in GAEB XML */
|
|
1223
752
|
artIndex?: number | undefined;
|
|
1224
|
-
/** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
|
|
1225
753
|
kindIdentifier?: number | undefined;
|
|
1226
754
|
constructor(data?: ISTLBKeyDto);
|
|
1227
755
|
init?(_data?: any): void;
|
|
1228
756
|
static fromJS(data: any): STLBKeyDto;
|
|
1229
757
|
toJSON?(data?: any): any;
|
|
1230
758
|
}
|
|
1231
|
-
/** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
|
|
1232
759
|
interface ISTLBKeyDto {
|
|
1233
|
-
/** This identifier is required and uniquely describes a single reference within the STLB standard. It maps to "ArtChrIdent" in GAEB XML */
|
|
1234
760
|
artIdentifier: number;
|
|
1235
|
-
/** This optional index property further categorizes a single reference within the STLB standard. It maps to "ArtChIdx" in GAEB XML */
|
|
1236
761
|
artIndex?: number | undefined;
|
|
1237
|
-
/** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
|
|
1238
762
|
kindIdentifier?: number | undefined;
|
|
1239
763
|
}
|
|
1240
|
-
/** Indicates if this service specification item is commissioned (and therefore should be executed), postponed for later or undefined. */
|
|
1241
764
|
declare enum ComissionStatusDto {
|
|
1242
765
|
Undefined = "Undefined",
|
|
1243
766
|
Commissioned = "Commissioned",
|
|
1244
767
|
Postponed = "Postponed",
|
|
1245
768
|
Removed = "Removed"
|
|
1246
769
|
}
|
|
1247
|
-
/** This model contains the sustainability or environment impact data. */
|
|
1248
770
|
declare class PositionSustainabilityIndicatorDto implements IPositionSustainabilityIndicatorDto {
|
|
1249
|
-
/** Elements GUID identifier. */
|
|
1250
771
|
id: string;
|
|
1251
|
-
/** This is usually in the form of an URL that specifies the indicator. */
|
|
1252
772
|
source?: string | undefined;
|
|
1253
|
-
/** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
|
|
1254
773
|
comment?: string | undefined;
|
|
1255
|
-
/** If present, this indicator may be divided up into different life cycle stages. */
|
|
1256
774
|
lifeCycleStages?: SustainabilityLifeCycleStageDto[] | undefined;
|
|
1257
|
-
/** This is a key that specifies the type of indicator. It is not used for any calculations but can be used to identify the indicator type, e.g. "carbonFootprint", "waterConsumption" or similar. The actual value of this property is not defined in the library and can be set freely, but it is recommended to use a consistent naming scheme, e.g. by using URLs or IRIs to avoid conflicts. In GAEB XML, it has a max length of 50 characters. */
|
|
1258
775
|
indicatorKey?: string | undefined;
|
|
1259
|
-
/** This is the actual value of the indicator. */
|
|
1260
776
|
value?: number | undefined;
|
|
1261
|
-
/** The unit of measurement for the value. */
|
|
1262
777
|
unitTag?: string | undefined;
|
|
1263
|
-
/** If present, this is a conversion factor used here in this indicator for the value. */
|
|
1264
778
|
conversionFactor?: number | undefined;
|
|
1265
779
|
constructor(data?: IPositionSustainabilityIndicatorDto);
|
|
1266
780
|
init?(_data?: any): void;
|
|
1267
781
|
static fromJS(data: any): PositionSustainabilityIndicatorDto;
|
|
1268
782
|
toJSON?(data?: any): any;
|
|
1269
783
|
}
|
|
1270
|
-
/** This model contains the sustainability or environment impact data. */
|
|
1271
784
|
interface IPositionSustainabilityIndicatorDto {
|
|
1272
|
-
/** Elements GUID identifier. */
|
|
1273
785
|
id: string;
|
|
1274
|
-
/** This is usually in the form of an URL that specifies the indicator. */
|
|
1275
786
|
source?: string | undefined;
|
|
1276
|
-
/** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
|
|
1277
787
|
comment?: string | undefined;
|
|
1278
|
-
/** If present, this indicator may be divided up into different life cycle stages. */
|
|
1279
788
|
lifeCycleStages?: ISustainabilityLifeCycleStageDto[] | undefined;
|
|
1280
|
-
/** This is a key that specifies the type of indicator. It is not used for any calculations but can be used to identify the indicator type, e.g. "carbonFootprint", "waterConsumption" or similar. The actual value of this property is not defined in the library and can be set freely, but it is recommended to use a consistent naming scheme, e.g. by using URLs or IRIs to avoid conflicts. In GAEB XML, it has a max length of 50 characters. */
|
|
1281
789
|
indicatorKey?: string | undefined;
|
|
1282
|
-
/** This is the actual value of the indicator. */
|
|
1283
790
|
value?: number | undefined;
|
|
1284
|
-
/** The unit of measurement for the value. */
|
|
1285
791
|
unitTag?: string | undefined;
|
|
1286
|
-
/** If present, this is a conversion factor used here in this indicator for the value. */
|
|
1287
792
|
conversionFactor?: number | undefined;
|
|
1288
793
|
}
|
|
1289
|
-
/** This model represents the life cycle stages for sustainability indicators. For example, for a carbon footprint indicator, you could specify the carbon footprint for the production stage, the transportation stage and the disposal stage of a service or product. */
|
|
1290
794
|
declare class SustainabilityLifeCycleStageDto implements ISustainabilityLifeCycleStageDto {
|
|
1291
|
-
/** Elements GUID identifier. */
|
|
1292
795
|
id: string;
|
|
1293
|
-
/** The key is the name or identifier of the stage. */
|
|
1294
796
|
key?: string | undefined;
|
|
1295
|
-
/** The value for this given stage. */
|
|
1296
797
|
value?: number | undefined;
|
|
1297
798
|
constructor(data?: ISustainabilityLifeCycleStageDto);
|
|
1298
799
|
init?(_data?: any): void;
|
|
1299
800
|
static fromJS(data: any): SustainabilityLifeCycleStageDto;
|
|
1300
801
|
toJSON?(data?: any): any;
|
|
1301
802
|
}
|
|
1302
|
-
/** This model represents the life cycle stages for sustainability indicators. For example, for a carbon footprint indicator, you could specify the carbon footprint for the production stage, the transportation stage and the disposal stage of a service or product. */
|
|
1303
803
|
interface ISustainabilityLifeCycleStageDto {
|
|
1304
|
-
/** Elements GUID identifier. */
|
|
1305
804
|
id: string;
|
|
1306
|
-
/** The key is the name or identifier of the stage. */
|
|
1307
805
|
key?: string | undefined;
|
|
1308
|
-
/** The value for this given stage. */
|
|
1309
806
|
value?: number | undefined;
|
|
1310
807
|
}
|
|
1311
|
-
/** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
|
|
1312
808
|
declare class ItemNumberDto implements IItemNumberDto {
|
|
1313
|
-
/** Elements GUID identifier. */
|
|
1314
809
|
id: string;
|
|
1315
|
-
/** Will return this ItemNumber as point delimited string. Will not distinguish between upper- and lowercase and return an all-lowercase representation. Will consider first numbers, then characters, e.g. 1a is considered preceding aa. Transformation to all lowercase can be configured in the ItemNumberSchema property. */
|
|
1316
810
|
stringRepresentation?: string | undefined;
|
|
1317
|
-
/** Indicates if the characters and the length of the Identifiers match the current ItemNumberSchema. */
|
|
1318
811
|
readonly isSchemaCompliant: boolean;
|
|
1319
|
-
/** Used for representing and validating this ItemNumber. */
|
|
1320
812
|
itemNumberSchema?: ItemNumberSchemaDto | undefined;
|
|
1321
|
-
/** Collection of the single identifiers in this ItemNumber. P.e., "02.03.004" will have three elements "02", "03", and "004". Since ReadOnlyObservableCollection`1 does have the event set to protected, it can be accessed like this: (itemNumber.Identifiers as INotifyCollectionChanged).CollectionChanged */
|
|
1322
813
|
identifiers?: string[] | undefined;
|
|
1323
|
-
/** This indicates if this item number is at the lot level. Find out more about lots in the documentation. */
|
|
1324
814
|
readonly isLot: boolean;
|
|
1325
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
1326
815
|
hierarchyLevel: number;
|
|
1327
|
-
/** This property indicates if this ItemNumber is attached to an object of the Position type. */
|
|
1328
816
|
readonly isAttachedToPosition: boolean;
|
|
1329
817
|
itemNumberSchemaBeforeMapping?: ItemNumberSchemaDto | undefined;
|
|
1330
818
|
constructor(data?: IItemNumberDto);
|
|
@@ -1332,249 +820,155 @@ declare class ItemNumberDto implements IItemNumberDto {
|
|
|
1332
820
|
static fromJS(data: any): ItemNumberDto;
|
|
1333
821
|
toJSON?(data?: any): any;
|
|
1334
822
|
}
|
|
1335
|
-
/** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
|
|
1336
823
|
interface IItemNumberDto {
|
|
1337
|
-
/** Elements GUID identifier. */
|
|
1338
824
|
id: string;
|
|
1339
|
-
/** Will return this ItemNumber as point delimited string. Will not distinguish between upper- and lowercase and return an all-lowercase representation. Will consider first numbers, then characters, e.g. 1a is considered preceding aa. Transformation to all lowercase can be configured in the ItemNumberSchema property. */
|
|
1340
825
|
stringRepresentation?: string | undefined;
|
|
1341
|
-
/** Indicates if the characters and the length of the Identifiers match the current ItemNumberSchema. */
|
|
1342
826
|
isSchemaCompliant: boolean;
|
|
1343
|
-
/** Used for representing and validating this ItemNumber. */
|
|
1344
827
|
itemNumberSchema?: IItemNumberSchemaDto | undefined;
|
|
1345
|
-
/** Collection of the single identifiers in this ItemNumber. P.e., "02.03.004" will have three elements "02", "03", and "004". Since ReadOnlyObservableCollection`1 does have the event set to protected, it can be accessed like this: (itemNumber.Identifiers as INotifyCollectionChanged).CollectionChanged */
|
|
1346
828
|
identifiers?: string[] | undefined;
|
|
1347
|
-
/** This indicates if this item number is at the lot level. Find out more about lots in the documentation. */
|
|
1348
829
|
isLot: boolean;
|
|
1349
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
1350
830
|
hierarchyLevel: number;
|
|
1351
|
-
/** This property indicates if this ItemNumber is attached to an object of the Position type. */
|
|
1352
831
|
isAttachedToPosition: boolean;
|
|
1353
832
|
itemNumberSchemaBeforeMapping?: IItemNumberSchemaDto | undefined;
|
|
1354
833
|
}
|
|
1355
|
-
/** This is a classification for Position elements. */
|
|
1356
834
|
declare enum PositionTypeDto {
|
|
1357
835
|
Regular = "Regular",
|
|
1358
836
|
Optional = "Optional",
|
|
1359
837
|
Alternative = "Alternative"
|
|
1360
838
|
}
|
|
1361
|
-
/** This indicates the price type of a IPricedElement. */
|
|
1362
839
|
declare enum PriceTypeDto {
|
|
1363
840
|
WithTotal = "WithTotal",
|
|
1364
841
|
WithoutTotal = "WithoutTotal"
|
|
1365
842
|
}
|
|
1366
|
-
/** The service type describes the type of service a Position represents. */
|
|
1367
843
|
declare enum ServiceTypeDto {
|
|
1368
844
|
Regular = "Regular",
|
|
1369
845
|
HourlyPaidWork = "HourlyPaidWork"
|
|
1370
846
|
}
|
|
1371
|
-
/** This class represents data about products and their vendor */
|
|
1372
847
|
declare class ProductDataDto implements IProductDataDto {
|
|
1373
|
-
/** Elements GUID identifier. */
|
|
1374
848
|
id: string;
|
|
1375
|
-
/** This PartyInformation is used to describe details about the vendor of this ProductData. */
|
|
1376
849
|
vendor?: PartyInformationDto | undefined;
|
|
1377
|
-
/** The collection of ArticleData that describe this product, e.g. a pipe product could be composed out of multiple pipe segments and fittings. */
|
|
1378
850
|
articles?: ArticleDataDto[] | undefined;
|
|
1379
|
-
/** Short description for this ITextElement element. */
|
|
1380
851
|
shortText?: string | undefined;
|
|
1381
|
-
/** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1382
852
|
longText?: string | undefined;
|
|
1383
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1384
853
|
htmlLongText?: string | undefined;
|
|
1385
854
|
constructor(data?: IProductDataDto);
|
|
1386
855
|
init?(_data?: any): void;
|
|
1387
856
|
static fromJS(data: any): ProductDataDto;
|
|
1388
857
|
toJSON?(data?: any): any;
|
|
1389
858
|
}
|
|
1390
|
-
/** This class represents data about products and their vendor */
|
|
1391
859
|
interface IProductDataDto {
|
|
1392
|
-
/** Elements GUID identifier. */
|
|
1393
860
|
id: string;
|
|
1394
|
-
/** This PartyInformation is used to describe details about the vendor of this ProductData. */
|
|
1395
861
|
vendor?: IPartyInformationDto | undefined;
|
|
1396
|
-
/** The collection of ArticleData that describe this product, e.g. a pipe product could be composed out of multiple pipe segments and fittings. */
|
|
1397
862
|
articles?: IArticleDataDto[] | undefined;
|
|
1398
|
-
/** Short description for this ITextElement element. */
|
|
1399
863
|
shortText?: string | undefined;
|
|
1400
|
-
/** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1401
864
|
longText?: string | undefined;
|
|
1402
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1403
865
|
htmlLongText?: string | undefined;
|
|
1404
866
|
}
|
|
1405
|
-
/** This class represents a single article, usually used within ProductData */
|
|
1406
867
|
declare class ArticleDataDto implements IArticleDataDto {
|
|
1407
|
-
/** Elements GUID identifier. */
|
|
1408
868
|
id: string;
|
|
1409
|
-
/** The name (or brand name) for this article, usually given by the supplier or vendor. */
|
|
1410
869
|
name?: string | undefined;
|
|
1411
|
-
/** An article number that describes it, useful when integrating other systems. */
|
|
1412
870
|
articleNumber?: string | undefined;
|
|
1413
|
-
/** Quantity for this article. If this is used within a Position, the quantity here should be the quantity required for the full quantity of the position, not for a single unit. */
|
|
1414
871
|
quantity: number;
|
|
1415
|
-
/** The unit tag for this single ArticleData. */
|
|
1416
872
|
unitTag?: string | undefined;
|
|
1417
|
-
/** This is an optional text element that can be used to further describe the ArticleData. */
|
|
1418
873
|
description?: string | undefined;
|
|
1419
|
-
/** Short description for this ITextElement element. */
|
|
1420
874
|
shortText?: string | undefined;
|
|
1421
|
-
/** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1422
875
|
longText?: string | undefined;
|
|
1423
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1424
876
|
htmlLongText?: string | undefined;
|
|
1425
877
|
constructor(data?: IArticleDataDto);
|
|
1426
878
|
init?(_data?: any): void;
|
|
1427
879
|
static fromJS(data: any): ArticleDataDto;
|
|
1428
880
|
toJSON?(data?: any): any;
|
|
1429
881
|
}
|
|
1430
|
-
/** This class represents a single article, usually used within ProductData */
|
|
1431
882
|
interface IArticleDataDto {
|
|
1432
|
-
/** Elements GUID identifier. */
|
|
1433
883
|
id: string;
|
|
1434
|
-
/** The name (or brand name) for this article, usually given by the supplier or vendor. */
|
|
1435
884
|
name?: string | undefined;
|
|
1436
|
-
/** An article number that describes it, useful when integrating other systems. */
|
|
1437
885
|
articleNumber?: string | undefined;
|
|
1438
|
-
/** Quantity for this article. If this is used within a Position, the quantity here should be the quantity required for the full quantity of the position, not for a single unit. */
|
|
1439
886
|
quantity: number;
|
|
1440
|
-
/** The unit tag for this single ArticleData. */
|
|
1441
887
|
unitTag?: string | undefined;
|
|
1442
|
-
/** This is an optional text element that can be used to further describe the ArticleData. */
|
|
1443
888
|
description?: string | undefined;
|
|
1444
|
-
/** Short description for this ITextElement element. */
|
|
1445
889
|
shortText?: string | undefined;
|
|
1446
|
-
/** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1447
890
|
longText?: string | undefined;
|
|
1448
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1449
891
|
htmlLongText?: string | undefined;
|
|
1450
892
|
}
|
|
1451
|
-
/** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes. */
|
|
1452
893
|
declare class QuantityAssignmentDto implements IQuantityAssignmentDto {
|
|
1453
|
-
/** Elements GUID identifier. */
|
|
1454
894
|
id: string;
|
|
1455
|
-
/** The total quantity in this quantity assignment */
|
|
1456
895
|
quantity: number;
|
|
1457
|
-
/** These are Catalogue that are used within this ServiceSpecification. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
1458
896
|
projectCatalogues?: CatalogueDto[] | undefined;
|
|
1459
|
-
/** Referenced catalogues for this QuantityAssignment. */
|
|
1460
897
|
catalogueReferences?: CatalogueReferenceDto[] | undefined;
|
|
1461
898
|
constructor(data?: IQuantityAssignmentDto);
|
|
1462
899
|
init?(_data?: any): void;
|
|
1463
900
|
static fromJS(data: any): QuantityAssignmentDto;
|
|
1464
901
|
toJSON?(data?: any): any;
|
|
1465
902
|
}
|
|
1466
|
-
/** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes. */
|
|
1467
903
|
interface IQuantityAssignmentDto {
|
|
1468
|
-
/** Elements GUID identifier. */
|
|
1469
904
|
id: string;
|
|
1470
|
-
/** The total quantity in this quantity assignment */
|
|
1471
905
|
quantity: number;
|
|
1472
|
-
/** These are Catalogue that are used within this ServiceSpecification. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. */
|
|
1473
906
|
projectCatalogues?: ICatalogueDto[] | undefined;
|
|
1474
|
-
/** Referenced catalogues for this QuantityAssignment. */
|
|
1475
907
|
catalogueReferences?: ICatalogueReferenceDto[] | undefined;
|
|
1476
908
|
}
|
|
1477
|
-
/** This class holds specialized information that is relevant to trade or commerce based data exchange scenarios, e.g. between customers, vendors, suppliers and distributors. It is used when exporting to GAEB XML 9x exchange phases. */
|
|
1478
909
|
declare class CommercePropertiesDto implements ICommercePropertiesDto {
|
|
1479
|
-
/** This maps to ArtNo in GAEB XML and represents an article number given by the supplier. */
|
|
1480
910
|
articleNumber?: string | undefined;
|
|
1481
|
-
/** This maps to EAN in GAEB XML and represents an GTIN (formerly EAN) article number. */
|
|
1482
911
|
eanGtinArticleNumber?: string | undefined;
|
|
1483
|
-
/** This maps to ArtNoID in GAEB XML and represents an ILN article number. */
|
|
1484
912
|
ilnArticleNumber?: string | undefined;
|
|
1485
|
-
/** This maps to CatalogNo in GAEB XML and represents an identifier of a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
|
|
1486
913
|
catalogueNumber?: string | undefined;
|
|
1487
|
-
/** This maps to CatalogArtNo in GAEB XML and represents a key that maps to an entry in a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
|
|
1488
914
|
catalogueArticleNumber?: string | undefined;
|
|
1489
|
-
/** This optional property can be used to indicate the basis for prices for a single position. Price basis means that the price is given per unit of the basis, e.g. per a pack of five when this property is set to '5'. */
|
|
1490
915
|
priceBasis?: number | undefined;
|
|
1491
|
-
/** This optional property can be used to indicate a sub position identifier specific for the commerce exchange */
|
|
1492
916
|
subPositionIdentifier?: string | undefined;
|
|
1493
|
-
/** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
|
|
1494
917
|
customerBaseItemNumber?: string | undefined;
|
|
1495
918
|
constructor(data?: ICommercePropertiesDto);
|
|
1496
919
|
init?(_data?: any): void;
|
|
1497
920
|
static fromJS(data: any): CommercePropertiesDto;
|
|
1498
921
|
toJSON?(data?: any): any;
|
|
1499
922
|
}
|
|
1500
|
-
/** This class holds specialized information that is relevant to trade or commerce based data exchange scenarios, e.g. between customers, vendors, suppliers and distributors. It is used when exporting to GAEB XML 9x exchange phases. */
|
|
1501
923
|
interface ICommercePropertiesDto {
|
|
1502
|
-
/** This maps to ArtNo in GAEB XML and represents an article number given by the supplier. */
|
|
1503
924
|
articleNumber?: string | undefined;
|
|
1504
|
-
/** This maps to EAN in GAEB XML and represents an GTIN (formerly EAN) article number. */
|
|
1505
925
|
eanGtinArticleNumber?: string | undefined;
|
|
1506
|
-
/** This maps to ArtNoID in GAEB XML and represents an ILN article number. */
|
|
1507
926
|
ilnArticleNumber?: string | undefined;
|
|
1508
|
-
/** This maps to CatalogNo in GAEB XML and represents an identifier of a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
|
|
1509
927
|
catalogueNumber?: string | undefined;
|
|
1510
|
-
/** This maps to CatalogArtNo in GAEB XML and represents a key that maps to an entry in a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
|
|
1511
928
|
catalogueArticleNumber?: string | undefined;
|
|
1512
|
-
/** This optional property can be used to indicate the basis for prices for a single position. Price basis means that the price is given per unit of the basis, e.g. per a pack of five when this property is set to '5'. */
|
|
1513
929
|
priceBasis?: number | undefined;
|
|
1514
|
-
/** This optional property can be used to indicate a sub position identifier specific for the commerce exchange */
|
|
1515
930
|
subPositionIdentifier?: string | undefined;
|
|
1516
|
-
/** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
|
|
1517
931
|
customerBaseItemNumber?: string | undefined;
|
|
1518
932
|
}
|
|
1519
|
-
/** This class represents the linking to a complementary position with a specific quantity set. For example, Position 'A' could be complementing Position 'B' with a total quantity of 20 units */
|
|
1520
933
|
declare class ComplementedByQuantityDto implements IComplementedByQuantityDto {
|
|
1521
|
-
/** The quantity that is complemented. E.g., if the base position has a quantity of 100 m² of a brick wall, a complementing position might be for 'walls that exceed 3 m height' and for a total quantity of 10 m². */
|
|
1522
934
|
quantity: number;
|
|
1523
|
-
/** This is the reference to the Id of the Position that is complementing. This means it does NOT reference the base position but the one that contains the actual addition. */
|
|
1524
935
|
complementingPositionId: string | undefined;
|
|
1525
936
|
constructor(data?: IComplementedByQuantityDto);
|
|
1526
937
|
init?(_data?: any): void;
|
|
1527
938
|
static fromJS(data: any): ComplementedByQuantityDto;
|
|
1528
939
|
toJSON?(data?: any): any;
|
|
1529
940
|
}
|
|
1530
|
-
/** This class represents the linking to a complementary position with a specific quantity set. For example, Position 'A' could be complementing Position 'B' with a total quantity of 20 units */
|
|
1531
941
|
interface IComplementedByQuantityDto {
|
|
1532
|
-
/** The quantity that is complemented. E.g., if the base position has a quantity of 100 m² of a brick wall, a complementing position might be for 'walls that exceed 3 m height' and for a total quantity of 10 m². */
|
|
1533
942
|
quantity: number;
|
|
1534
|
-
/** This is the reference to the Id of the Position that is complementing. This means it does NOT reference the base position but the one that contains the actual addition. */
|
|
1535
943
|
complementingPositionId: string | undefined;
|
|
1536
944
|
}
|
|
1537
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
|
|
1538
945
|
declare class OenormPositionPropertiesDto implements IOenormPositionPropertiesDto {
|
|
1539
|
-
|
|
1540
|
-
originCode: OenormOriginCodeDto;
|
|
1541
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
946
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1542
947
|
openingTextIsFreeText: boolean;
|
|
1543
|
-
/** This indicates if the ÖNorm 'wesentliche position' mark is set. This should no longer be used, please use the IsMainPosition property on the parent position instead. */
|
|
1544
948
|
isMainPosition: boolean;
|
|
1545
|
-
/** This indicates if the ÖNorm position was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position is also the sole element inside it's parent group */
|
|
1546
949
|
isUndividedPosition: boolean;
|
|
1547
|
-
/** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
|
|
1548
950
|
oenormShortText?: string | undefined;
|
|
1549
|
-
/** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
|
|
1550
951
|
oenormShortTextAddition?: string | undefined;
|
|
952
|
+
partialOfferMark?: string | undefined;
|
|
1551
953
|
constructor(data?: IOenormPositionPropertiesDto);
|
|
1552
954
|
init?(_data?: any): void;
|
|
1553
955
|
static fromJS(data: any): OenormPositionPropertiesDto;
|
|
1554
956
|
toJSON?(data?: any): any;
|
|
1555
957
|
}
|
|
1556
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
|
|
1557
958
|
interface IOenormPositionPropertiesDto {
|
|
1558
|
-
|
|
1559
|
-
originCode: OenormOriginCodeDto;
|
|
1560
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
959
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1561
960
|
openingTextIsFreeText: boolean;
|
|
1562
|
-
/** This indicates if the ÖNorm 'wesentliche position' mark is set. This should no longer be used, please use the IsMainPosition property on the parent position instead. */
|
|
1563
961
|
isMainPosition: boolean;
|
|
1564
|
-
/** This indicates if the ÖNorm position was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position is also the sole element inside it's parent group */
|
|
1565
962
|
isUndividedPosition: boolean;
|
|
1566
|
-
/** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
|
|
1567
963
|
oenormShortText?: string | undefined;
|
|
1568
|
-
/** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
|
|
1569
964
|
oenormShortTextAddition?: string | undefined;
|
|
965
|
+
partialOfferMark?: string | undefined;
|
|
1570
966
|
}
|
|
1571
|
-
/** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
|
|
1572
967
|
declare enum OenormOriginCodeDto {
|
|
1573
968
|
Unknown = "Unknown",
|
|
1574
969
|
FreeText = "FreeText",
|
|
1575
970
|
AdditionDescription = "AdditionDescription"
|
|
1576
971
|
}
|
|
1577
|
-
/** This enumeration represents the status of an addendum, 'Nachtrag' in German */
|
|
1578
972
|
declare enum AddendumStatusDto {
|
|
1579
973
|
Unknown = "Unknown",
|
|
1580
974
|
Recognized = "Recognized",
|
|
@@ -1586,51 +980,36 @@ declare enum AddendumStatusDto {
|
|
|
1586
980
|
FormallyAcknowledged = "FormallyAcknowledged",
|
|
1587
981
|
Approved = "Approved"
|
|
1588
982
|
}
|
|
1589
|
-
/** This enum represents the different ways in which a complementing position type can be specified. It is typically only used in GAEB exports, since in Dangl.AVA, complementing positions are always explicitly referenced. */
|
|
1590
983
|
declare enum PositionComplementingTypeDto {
|
|
1591
984
|
Undefined = "Undefined",
|
|
1592
985
|
AllPreviousMarkedPositions = "AllPreviousMarkedPositions",
|
|
1593
986
|
AllPreviousPositions = "AllPreviousPositions",
|
|
1594
987
|
ReferencedPositions = "ReferencedPositions"
|
|
1595
988
|
}
|
|
1596
|
-
/** This class holds properties that describe retention types in position. Retention / hold out usually means that a service is provided and kept available for a specific amount of time, e.g. fences on a construction site */
|
|
1597
989
|
declare class PositionHoldOutPropertiesDto implements IPositionHoldOutPropertiesDto {
|
|
1598
|
-
/** Elements GUID identifier. */
|
|
1599
990
|
id: string;
|
|
1600
|
-
|
|
1601
|
-
holdOutType: HoldOutTypeDto;
|
|
1602
|
-
/** The duration of the period */
|
|
991
|
+
holdOutType?: HoldOutTypeDto | undefined;
|
|
1603
992
|
holdOutDuration: number;
|
|
1604
|
-
|
|
1605
|
-
holdOutDurationUnit: HoldOutDurationUnitDto;
|
|
1606
|
-
/** References to base positions */
|
|
993
|
+
holdOutDurationUnit?: HoldOutDurationUnitDto | undefined;
|
|
1607
994
|
basePositionReferences?: string[] | undefined;
|
|
1608
995
|
constructor(data?: IPositionHoldOutPropertiesDto);
|
|
1609
996
|
init?(_data?: any): void;
|
|
1610
997
|
static fromJS(data: any): PositionHoldOutPropertiesDto;
|
|
1611
998
|
toJSON?(data?: any): any;
|
|
1612
999
|
}
|
|
1613
|
-
/** This class holds properties that describe retention types in position. Retention / hold out usually means that a service is provided and kept available for a specific amount of time, e.g. fences on a construction site */
|
|
1614
1000
|
interface IPositionHoldOutPropertiesDto {
|
|
1615
|
-
/** Elements GUID identifier. */
|
|
1616
1001
|
id: string;
|
|
1617
|
-
|
|
1618
|
-
holdOutType: HoldOutTypeDto;
|
|
1619
|
-
/** The duration of the period */
|
|
1002
|
+
holdOutType?: HoldOutTypeDto | undefined;
|
|
1620
1003
|
holdOutDuration: number;
|
|
1621
|
-
|
|
1622
|
-
holdOutDurationUnit: HoldOutDurationUnitDto;
|
|
1623
|
-
/** References to base positions */
|
|
1004
|
+
holdOutDurationUnit?: HoldOutDurationUnitDto | undefined;
|
|
1624
1005
|
basePositionReferences?: string[] | undefined;
|
|
1625
1006
|
}
|
|
1626
|
-
/** Types of retentions to be used in positions */
|
|
1627
1007
|
declare enum HoldOutTypeDto {
|
|
1628
1008
|
Unknown = "Unknown",
|
|
1629
1009
|
Base = "Base",
|
|
1630
1010
|
Extension = "Extension",
|
|
1631
1011
|
Rent = "Rent"
|
|
1632
1012
|
}
|
|
1633
|
-
/** Duration used in retention positions */
|
|
1634
1013
|
declare enum HoldOutDurationUnitDto {
|
|
1635
1014
|
Unknown = "Unknown",
|
|
1636
1015
|
Minutes = "Minutes",
|
|
@@ -1639,51 +1018,31 @@ declare enum HoldOutDurationUnitDto {
|
|
|
1639
1018
|
Weeks = "Weeks",
|
|
1640
1019
|
Months = "Months"
|
|
1641
1020
|
}
|
|
1642
|
-
/** Price catalogue data represents assumed or estimated prices from a catalogue source */
|
|
1643
1021
|
declare class PriceCatalogueDataDto implements IPriceCatalogueDataDto {
|
|
1644
|
-
/** Elements GUID identifier. */
|
|
1645
1022
|
id: string;
|
|
1646
|
-
/** The lower bound of the unit price */
|
|
1647
1023
|
unitPriceFrom?: number | undefined;
|
|
1648
|
-
/** The upper bound of the unit price */
|
|
1649
1024
|
unitPriceTo?: number | undefined;
|
|
1650
|
-
/** The average unit price */
|
|
1651
1025
|
unitPriceAverage?: number | undefined;
|
|
1652
|
-
/** The lower bound of the wage price */
|
|
1653
1026
|
wagePriceFrom?: number | undefined;
|
|
1654
|
-
/** The upper bound of the wage price */
|
|
1655
1027
|
wagePriceTo?: number | undefined;
|
|
1656
|
-
/** The average wage price */
|
|
1657
1028
|
wagePriceAverage?: number | undefined;
|
|
1658
1029
|
constructor(data?: IPriceCatalogueDataDto);
|
|
1659
1030
|
init?(_data?: any): void;
|
|
1660
1031
|
static fromJS(data: any): PriceCatalogueDataDto;
|
|
1661
1032
|
toJSON?(data?: any): any;
|
|
1662
1033
|
}
|
|
1663
|
-
/** Price catalogue data represents assumed or estimated prices from a catalogue source */
|
|
1664
1034
|
interface IPriceCatalogueDataDto {
|
|
1665
|
-
/** Elements GUID identifier. */
|
|
1666
1035
|
id: string;
|
|
1667
|
-
/** The lower bound of the unit price */
|
|
1668
1036
|
unitPriceFrom?: number | undefined;
|
|
1669
|
-
/** The upper bound of the unit price */
|
|
1670
1037
|
unitPriceTo?: number | undefined;
|
|
1671
|
-
/** The average unit price */
|
|
1672
1038
|
unitPriceAverage?: number | undefined;
|
|
1673
|
-
/** The lower bound of the wage price */
|
|
1674
1039
|
wagePriceFrom?: number | undefined;
|
|
1675
|
-
/** The upper bound of the wage price */
|
|
1676
1040
|
wagePriceTo?: number | undefined;
|
|
1677
|
-
/** The average wage price */
|
|
1678
1041
|
wagePriceAverage?: number | undefined;
|
|
1679
1042
|
}
|
|
1680
|
-
/** An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed. */
|
|
1681
1043
|
declare class ExecutionDescriptionDto extends IElementDto implements IExecutionDescriptionDto {
|
|
1682
|
-
/** Blocks within an ExecutionDescription contain the actual information. */
|
|
1683
1044
|
blocks?: NoteTextDto[] | undefined;
|
|
1684
|
-
/** Labels this ExecutionDescription. */
|
|
1685
1045
|
label?: string | undefined;
|
|
1686
|
-
/** Uniquely identifies this ExecutionDescription. */
|
|
1687
1046
|
identifier?: string | undefined;
|
|
1688
1047
|
elementType: string;
|
|
1689
1048
|
elementTypeDiscriminator: string;
|
|
@@ -1692,311 +1051,182 @@ declare class ExecutionDescriptionDto extends IElementDto implements IExecutionD
|
|
|
1692
1051
|
static fromJS(data: any): ExecutionDescriptionDto;
|
|
1693
1052
|
toJSON(data?: any): any;
|
|
1694
1053
|
}
|
|
1695
|
-
/** An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed. */
|
|
1696
1054
|
interface IExecutionDescriptionDto extends IIElementDto {
|
|
1697
|
-
/** Blocks within an ExecutionDescription contain the actual information. */
|
|
1698
1055
|
blocks?: NoteTextDto[] | undefined;
|
|
1699
|
-
/** Labels this ExecutionDescription. */
|
|
1700
1056
|
label?: string | undefined;
|
|
1701
|
-
/** Uniquely identifies this ExecutionDescription. */
|
|
1702
1057
|
identifier?: string | undefined;
|
|
1703
1058
|
elementType: string;
|
|
1704
1059
|
}
|
|
1705
|
-
/** Represents an element that holds text information. */
|
|
1706
1060
|
declare class NoteTextDto extends IElementDto implements INoteTextDto {
|
|
1707
|
-
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special opening text at the beginning of the project. For example, in GAEB XML, this would map to the GAEB.Award.AddText. Typically, such texts describe project-wide contractual definitions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
1708
1061
|
isOpeningText: boolean;
|
|
1709
|
-
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
1710
1062
|
isClosingText: boolean;
|
|
1711
|
-
/**
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
1715
|
-
*/
|
|
1063
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
1064
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
1065
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
1716
1066
|
shortText?: string | undefined;
|
|
1717
|
-
/** This
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
1721
|
-
*/
|
|
1067
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
1068
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
1069
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
1722
1070
|
htmlShortText?: string | undefined;
|
|
1723
|
-
|
|
1724
|
-
additionType: AdditionTypeDto;
|
|
1725
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1071
|
+
additionType?: AdditionTypeDto | undefined;
|
|
1726
1072
|
longText?: string | undefined;
|
|
1727
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1728
1073
|
htmlLongText?: string | undefined;
|
|
1729
|
-
/** This is an optional internal identifier that may be used to add additional information to this NoteText. It is not supported in GAEB import or export. */
|
|
1730
1074
|
identifier?: string | undefined;
|
|
1731
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
1732
1075
|
standardizedDescription?: StandardizedDescriptionDto | undefined;
|
|
1733
1076
|
elementType: string;
|
|
1734
1077
|
elementTypeDiscriminator: string;
|
|
1735
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
1736
1078
|
descriptionId?: string | undefined;
|
|
1737
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
|
|
1738
1079
|
oenormNoteTextProperties?: OenormNoteTextPropertiesDto | undefined;
|
|
1739
1080
|
readonly hasBidderCommentInHtmlLongText: boolean;
|
|
1740
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
1741
1081
|
baseCatalogueNumber?: string | undefined;
|
|
1742
1082
|
constructor(data?: INoteTextDto);
|
|
1743
1083
|
init(_data?: any): void;
|
|
1744
1084
|
static fromJS(data: any): NoteTextDto;
|
|
1745
1085
|
toJSON(data?: any): any;
|
|
1746
1086
|
}
|
|
1747
|
-
/** Represents an element that holds text information. */
|
|
1748
1087
|
interface INoteTextDto extends IIElementDto {
|
|
1749
|
-
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special opening text at the beginning of the project. For example, in GAEB XML, this would map to the GAEB.Award.AddText. Typically, such texts describe project-wide contractual definitions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
1750
1088
|
isOpeningText: boolean;
|
|
1751
|
-
/** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
|
|
1752
1089
|
isClosingText: boolean;
|
|
1753
|
-
/**
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
`HtmlShortText` property, you need to set this property to null.
|
|
1757
|
-
*/
|
|
1090
|
+
/** Please note that by default, this property takes precedence over the `HtmlShortText`
|
|
1091
|
+
property. If you want to convert from DTO objects, and you want to work with the
|
|
1092
|
+
`HtmlShortText` property, you need to set this property to null. */
|
|
1758
1093
|
shortText?: string | undefined;
|
|
1759
|
-
/** This
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
|
|
1763
|
-
*/
|
|
1094
|
+
/** This property is used to store the short text in HTML format. If you want to convert
|
|
1095
|
+
from DTO objects, and you want to use this property, then you need to ensure that
|
|
1096
|
+
`ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
|
|
1764
1097
|
htmlShortText?: string | undefined;
|
|
1765
|
-
|
|
1766
|
-
additionType: AdditionTypeDto;
|
|
1767
|
-
/** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
|
|
1098
|
+
additionType?: AdditionTypeDto | undefined;
|
|
1768
1099
|
longText?: string | undefined;
|
|
1769
|
-
/** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
|
|
1770
1100
|
htmlLongText?: string | undefined;
|
|
1771
|
-
/** This is an optional internal identifier that may be used to add additional information to this NoteText. It is not supported in GAEB import or export. */
|
|
1772
1101
|
identifier?: string | undefined;
|
|
1773
|
-
/** This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding. */
|
|
1774
1102
|
standardizedDescription?: IStandardizedDescriptionDto | undefined;
|
|
1775
1103
|
elementType: string;
|
|
1776
|
-
/** This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself. */
|
|
1777
1104
|
descriptionId?: string | undefined;
|
|
1778
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
|
|
1779
1105
|
oenormNoteTextProperties?: IOenormNoteTextPropertiesDto | undefined;
|
|
1780
1106
|
hasBidderCommentInHtmlLongText: boolean;
|
|
1781
|
-
/** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
|
|
1782
1107
|
baseCatalogueNumber?: string | undefined;
|
|
1783
1108
|
}
|
|
1784
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
|
|
1785
1109
|
declare class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto {
|
|
1786
|
-
|
|
1787
|
-
originCode: OenormOriginCodeDto;
|
|
1788
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
1110
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1789
1111
|
openingTextIsFreeText: boolean;
|
|
1790
|
-
/** This indicates if the ÖNorm position / note text was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position / note text is also the sole element inside it's parent group */
|
|
1791
1112
|
isUndividedPosition: boolean;
|
|
1792
1113
|
constructor(data?: IOenormNoteTextPropertiesDto);
|
|
1793
1114
|
init?(_data?: any): void;
|
|
1794
1115
|
static fromJS(data: any): OenormNoteTextPropertiesDto;
|
|
1795
1116
|
toJSON?(data?: any): any;
|
|
1796
1117
|
}
|
|
1797
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
|
|
1798
1118
|
interface IOenormNoteTextPropertiesDto {
|
|
1799
|
-
|
|
1800
|
-
originCode: OenormOriginCodeDto;
|
|
1801
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
1119
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1802
1120
|
openingTextIsFreeText: boolean;
|
|
1803
|
-
/** This indicates if the ÖNorm position / note text was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position / note text is also the sole element inside it's parent group */
|
|
1804
1121
|
isUndividedPosition: boolean;
|
|
1805
1122
|
}
|
|
1806
|
-
/** This is a grouping IElement that holds other IElements within. */
|
|
1807
1123
|
declare class ServiceSpecificationGroupDto extends IElementDto implements IServiceSpecificationGroupDto {
|
|
1808
|
-
/** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
1809
1124
|
readonly projectHourlyWage: number;
|
|
1810
|
-
/** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
1811
1125
|
projectTaxRate: number;
|
|
1812
|
-
/** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
|
|
1813
1126
|
projectPriceComponents?: string[] | undefined;
|
|
1814
|
-
/** The ItemNumberSchema that is used within this project. */
|
|
1815
1127
|
projectItemNumberSchema?: ItemNumberSchemaDto | undefined;
|
|
1816
|
-
/** The IElements within this ElementContainerBase. */
|
|
1817
1128
|
elements?: IElementDto[] | undefined;
|
|
1818
|
-
/** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
|
|
1819
1129
|
readonly projectLabourTimeLabel?: string | undefined;
|
|
1820
|
-
/** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
1821
1130
|
readonly containsDuplicateItemNumbers: boolean;
|
|
1822
|
-
/** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
1823
1131
|
readonly containsDuplicateElementIds: boolean;
|
|
1824
|
-
/** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
1825
1132
|
ignoreDuplicateItemNumbers: boolean;
|
|
1826
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
|
|
1827
1133
|
ignoreProjectCataloguePropagation: boolean;
|
|
1828
|
-
/** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
1829
1134
|
ignoreDuplicateElementIds: boolean;
|
|
1830
|
-
/** Price composition by tax rate. */
|
|
1831
1135
|
totalPriceGrossByTaxRate?: GrossPriceComponentDto[] | undefined;
|
|
1832
|
-
/** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
|
|
1833
1136
|
ignoreChildPriceUpdates: boolean;
|
|
1834
|
-
/** Net price after applied deductions. */
|
|
1835
1137
|
readonly deductedPrice: number;
|
|
1836
|
-
/** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
|
|
1837
1138
|
deductionFactor: number;
|
|
1838
|
-
/** The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum. */
|
|
1839
1139
|
absoluteDeduction?: number | undefined;
|
|
1840
|
-
/** Will return this ElementContainerBase's total price. */
|
|
1841
1140
|
readonly totalPrice: number;
|
|
1842
|
-
/** The total gross price for this ElementContainerBase including all child elements. */
|
|
1843
1141
|
readonly totalPriceGross: number;
|
|
1844
|
-
/** Total gross price after applied deductions. */
|
|
1845
1142
|
readonly totalPriceGrossDeducted: number;
|
|
1846
|
-
|
|
1847
|
-
priceType: PriceTypeDto;
|
|
1848
|
-
/** Description for this ServiceSpecificationGroup. */
|
|
1143
|
+
priceType?: PriceTypeDto | undefined;
|
|
1849
1144
|
shortText?: string | undefined;
|
|
1850
|
-
|
|
1851
|
-
comissionStatus: ComissionStatusDto;
|
|
1852
|
-
/** The ItemNumber for this INumberedElement interface. */
|
|
1145
|
+
comissionStatus?: ComissionStatusDto | undefined;
|
|
1853
1146
|
itemNumber?: ItemNumberDto | undefined;
|
|
1854
1147
|
elementType: string;
|
|
1855
1148
|
elementTypeDiscriminator: string;
|
|
1856
|
-
/** This indicates if this group is the parent of a lot. See the documentation for more information about working with lots. */
|
|
1857
1149
|
readonly isLot: boolean;
|
|
1858
|
-
/** If this group is an alternative for a base group, then this property should point to the id of the group in this service specification that it can replace. If this is an alternative group to a base group, the PriceType should typically be set to "WithoutTotal" so this group does not factor into total costs. The PriceType is not changed when this property is set */
|
|
1859
1150
|
alternativeTo: string | undefined;
|
|
1860
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
|
|
1861
1151
|
oenormProperties?: OenormPropertiesDto | undefined;
|
|
1862
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
1863
1152
|
hierarchyLevel: number;
|
|
1864
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
1865
1153
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
1866
|
-
/** This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific group is assigned to. That way, if you specifiy multiple alternative ServiceSpecificationGroups with the same AlternativeIdentifier, you can indicate that to replace a single base ServiceSpecificationGroup, multiple alternative ServiceSpecificationGroups should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
|
|
1867
1154
|
alternativeIdentifier?: number | undefined;
|
|
1868
|
-
/** This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific group is assigned to. That way, you can specify the id (in integer format) for the alternative group this group belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a group only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base group for a specific group. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
|
|
1869
1155
|
alternativeGroupIdentifier?: number | undefined;
|
|
1870
1156
|
constructor(data?: IServiceSpecificationGroupDto);
|
|
1871
1157
|
init(_data?: any): void;
|
|
1872
1158
|
static fromJS(data: any): ServiceSpecificationGroupDto;
|
|
1873
1159
|
toJSON(data?: any): any;
|
|
1874
1160
|
}
|
|
1875
|
-
/** This is a grouping IElement that holds other IElements within. */
|
|
1876
1161
|
interface IServiceSpecificationGroupDto extends IIElementDto {
|
|
1877
|
-
/** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
1878
1162
|
projectHourlyWage: number;
|
|
1879
|
-
/** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
|
|
1880
1163
|
projectTaxRate: number;
|
|
1881
|
-
/** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
|
|
1882
1164
|
projectPriceComponents?: string[] | undefined;
|
|
1883
|
-
/** The ItemNumberSchema that is used within this project. */
|
|
1884
1165
|
projectItemNumberSchema?: IItemNumberSchemaDto | undefined;
|
|
1885
|
-
/** The IElements within this ElementContainerBase. */
|
|
1886
1166
|
elements?: IElementDto[] | undefined;
|
|
1887
|
-
/** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
|
|
1888
1167
|
projectLabourTimeLabel?: string | undefined;
|
|
1889
|
-
/** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
1890
1168
|
containsDuplicateItemNumbers: boolean;
|
|
1891
|
-
/** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
|
|
1892
1169
|
containsDuplicateElementIds: boolean;
|
|
1893
|
-
/** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
1894
1170
|
ignoreDuplicateItemNumbers: boolean;
|
|
1895
|
-
/** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
|
|
1896
1171
|
ignoreProjectCataloguePropagation: boolean;
|
|
1897
|
-
/** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
|
|
1898
1172
|
ignoreDuplicateElementIds: boolean;
|
|
1899
|
-
/** Price composition by tax rate. */
|
|
1900
1173
|
totalPriceGrossByTaxRate?: IGrossPriceComponentDto[] | undefined;
|
|
1901
|
-
/** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
|
|
1902
1174
|
ignoreChildPriceUpdates: boolean;
|
|
1903
|
-
/** Net price after applied deductions. */
|
|
1904
1175
|
deductedPrice: number;
|
|
1905
|
-
/** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
|
|
1906
1176
|
deductionFactor: number;
|
|
1907
|
-
/** The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum. */
|
|
1908
1177
|
absoluteDeduction?: number | undefined;
|
|
1909
|
-
/** Will return this ElementContainerBase's total price. */
|
|
1910
1178
|
totalPrice: number;
|
|
1911
|
-
/** The total gross price for this ElementContainerBase including all child elements. */
|
|
1912
1179
|
totalPriceGross: number;
|
|
1913
|
-
/** Total gross price after applied deductions. */
|
|
1914
1180
|
totalPriceGrossDeducted: number;
|
|
1915
|
-
|
|
1916
|
-
priceType: PriceTypeDto;
|
|
1917
|
-
/** Description for this ServiceSpecificationGroup. */
|
|
1181
|
+
priceType?: PriceTypeDto | undefined;
|
|
1918
1182
|
shortText?: string | undefined;
|
|
1919
|
-
|
|
1920
|
-
comissionStatus: ComissionStatusDto;
|
|
1921
|
-
/** The ItemNumber for this INumberedElement interface. */
|
|
1183
|
+
comissionStatus?: ComissionStatusDto | undefined;
|
|
1922
1184
|
itemNumber?: IItemNumberDto | undefined;
|
|
1923
1185
|
elementType: string;
|
|
1924
|
-
/** This indicates if this group is the parent of a lot. See the documentation for more information about working with lots. */
|
|
1925
1186
|
isLot: boolean;
|
|
1926
|
-
/** If this group is an alternative for a base group, then this property should point to the id of the group in this service specification that it can replace. If this is an alternative group to a base group, the PriceType should typically be set to "WithoutTotal" so this group does not factor into total costs. The PriceType is not changed when this property is set */
|
|
1927
1187
|
alternativeTo: string | undefined;
|
|
1928
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
|
|
1929
1188
|
oenormProperties?: IOenormPropertiesDto | undefined;
|
|
1930
|
-
/** This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element. */
|
|
1931
1189
|
hierarchyLevel: number;
|
|
1932
|
-
/** This indicates, if this element is part of an addendum an, if yes, with what status. */
|
|
1933
1190
|
addendumStatus?: AddendumStatusDto | undefined;
|
|
1934
|
-
/** This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific group is assigned to. That way, if you specifiy multiple alternative ServiceSpecificationGroups with the same AlternativeIdentifier, you can indicate that to replace a single base ServiceSpecificationGroup, multiple alternative ServiceSpecificationGroups should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
|
|
1935
1191
|
alternativeIdentifier?: number | undefined;
|
|
1936
|
-
/** This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific group is assigned to. That way, you can specify the id (in integer format) for the alternative group this group belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a group only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base group for a specific group. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
|
|
1937
1192
|
alternativeGroupIdentifier?: number | undefined;
|
|
1938
1193
|
}
|
|
1939
|
-
/** This is used in an ElementContainerBase to hold the price composition. */
|
|
1940
1194
|
declare class GrossPriceComponentDto implements IGrossPriceComponentDto {
|
|
1941
|
-
/** This components tax rate. */
|
|
1942
1195
|
taxRate: number;
|
|
1943
|
-
/** This is the factor of applied deductions for this component */
|
|
1944
1196
|
deductionFactor: number;
|
|
1945
|
-
/** The total net price for all components of a given tax rate. */
|
|
1946
1197
|
totalNet: number;
|
|
1947
|
-
/** The resulting price component after applied deductions */
|
|
1948
1198
|
readonly totalDeducted: number;
|
|
1949
|
-
/** The total tax amount for all components of a given tax rate. */
|
|
1950
1199
|
readonly totalTax: number;
|
|
1951
|
-
/** The total gross price for all components of a given tax rate. */
|
|
1952
1200
|
readonly totalGross: number;
|
|
1953
|
-
/** The total gross price for all components of a given tax rate, after applied deductions. */
|
|
1954
1201
|
readonly totalGrossDeducted: number;
|
|
1955
|
-
/** The total tax amount for all components of a given tax rate, after applied deductions. */
|
|
1956
1202
|
readonly totalTaxDeducted: number;
|
|
1957
1203
|
constructor(data?: IGrossPriceComponentDto);
|
|
1958
1204
|
init?(_data?: any): void;
|
|
1959
1205
|
static fromJS(data: any): GrossPriceComponentDto;
|
|
1960
1206
|
toJSON?(data?: any): any;
|
|
1961
1207
|
}
|
|
1962
|
-
/** This is used in an ElementContainerBase to hold the price composition. */
|
|
1963
1208
|
interface IGrossPriceComponentDto {
|
|
1964
|
-
/** This components tax rate. */
|
|
1965
1209
|
taxRate: number;
|
|
1966
|
-
/** This is the factor of applied deductions for this component */
|
|
1967
1210
|
deductionFactor: number;
|
|
1968
|
-
/** The total net price for all components of a given tax rate. */
|
|
1969
1211
|
totalNet: number;
|
|
1970
|
-
/** The resulting price component after applied deductions */
|
|
1971
1212
|
totalDeducted: number;
|
|
1972
|
-
/** The total tax amount for all components of a given tax rate. */
|
|
1973
1213
|
totalTax: number;
|
|
1974
|
-
/** The total gross price for all components of a given tax rate. */
|
|
1975
1214
|
totalGross: number;
|
|
1976
|
-
/** The total gross price for all components of a given tax rate, after applied deductions. */
|
|
1977
1215
|
totalGrossDeducted: number;
|
|
1978
|
-
/** The total tax amount for all components of a given tax rate, after applied deductions. */
|
|
1979
1216
|
totalTaxDeducted: number;
|
|
1980
1217
|
}
|
|
1981
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
|
|
1982
1218
|
declare class OenormPropertiesDto implements IOenormPropertiesDto {
|
|
1983
|
-
|
|
1984
|
-
originCode: OenormOriginCodeDto;
|
|
1985
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
1219
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1986
1220
|
openingTextIsFreeText: boolean;
|
|
1987
1221
|
constructor(data?: IOenormPropertiesDto);
|
|
1988
1222
|
init?(_data?: any): void;
|
|
1989
1223
|
static fromJS(data: any): OenormPropertiesDto;
|
|
1990
1224
|
toJSON?(data?: any): any;
|
|
1991
1225
|
}
|
|
1992
|
-
/** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
|
|
1993
1226
|
interface IOenormPropertiesDto {
|
|
1994
|
-
|
|
1995
|
-
originCode: OenormOriginCodeDto;
|
|
1996
|
-
/** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
|
|
1227
|
+
originCode?: OenormOriginCodeDto | undefined;
|
|
1997
1228
|
openingTextIsFreeText: boolean;
|
|
1998
1229
|
}
|
|
1999
|
-
/** Indicates a ServiceSpecification's exchange phase, based on the GAEB exchange phases. */
|
|
2000
1230
|
declare enum ExchangePhaseDto {
|
|
2001
1231
|
Undefined = "Undefined",
|
|
2002
1232
|
Base = "Base",
|
|
@@ -2006,7 +1236,6 @@ declare enum ExchangePhaseDto {
|
|
|
2006
1236
|
SideOffer = "SideOffer",
|
|
2007
1237
|
Grant = "Grant"
|
|
2008
1238
|
}
|
|
2009
|
-
/** Indicates where a service specification was originally created. */
|
|
2010
1239
|
declare enum OriginDto {
|
|
2011
1240
|
Self = "Self",
|
|
2012
1241
|
Gaeb90 = "Gaeb90",
|
|
@@ -2016,216 +1245,132 @@ declare enum OriginDto {
|
|
|
2016
1245
|
Reb = "Reb",
|
|
2017
1246
|
Sia = "Sia"
|
|
2018
1247
|
}
|
|
2019
|
-
/** Holds global price information for a ServiceSpecification */
|
|
2020
1248
|
declare class PriceInformationDto implements IPriceInformationDto {
|
|
2021
|
-
/** Elements GUID identifier. */
|
|
2022
1249
|
id: string;
|
|
2023
|
-
/** The amount of currency per one hour of manual labour work in this project. */
|
|
2024
1250
|
hourlyWage: number;
|
|
2025
|
-
/** The final, total price will be deducted by this rate. */
|
|
2026
1251
|
deductionFactor: number;
|
|
2027
|
-
/** This is given when there is only one flat price for the whole service specification. */
|
|
2028
1252
|
flatSum: number;
|
|
2029
|
-
/** Global tax rate for the project. Note that certain elements may have a different, specific tax rate. */
|
|
2030
1253
|
taxRate: number;
|
|
2031
|
-
/** This property indicates if the TaxRate property is actually zero (0) or if it's just unset. The TaxRate is a non-nullable property, so it can't be null and therefore a distinction between unset and zero relies on this additional property. When exporting to GAEB, this can be used e.g. to decide whether or not the tax rate should be serialized. This property is automtically set to false when the TaxRate is set to any value, even zero. If the TaxRate is not set to zero, this property will always return false and can not be set to true. */
|
|
2032
1254
|
hasUnsetTaxRate: boolean;
|
|
2033
|
-
/** Trade discounts for offered in this ServiceSpecification. */
|
|
2034
1255
|
tradeDiscounts?: TradeDiscountDto[] | undefined;
|
|
2035
1256
|
constructor(data?: IPriceInformationDto);
|
|
2036
1257
|
init?(_data?: any): void;
|
|
2037
1258
|
static fromJS(data: any): PriceInformationDto;
|
|
2038
1259
|
toJSON?(data?: any): any;
|
|
2039
1260
|
}
|
|
2040
|
-
/** Holds global price information for a ServiceSpecification */
|
|
2041
1261
|
interface IPriceInformationDto {
|
|
2042
|
-
/** Elements GUID identifier. */
|
|
2043
1262
|
id: string;
|
|
2044
|
-
/** The amount of currency per one hour of manual labour work in this project. */
|
|
2045
1263
|
hourlyWage: number;
|
|
2046
|
-
/** The final, total price will be deducted by this rate. */
|
|
2047
1264
|
deductionFactor: number;
|
|
2048
|
-
/** This is given when there is only one flat price for the whole service specification. */
|
|
2049
1265
|
flatSum: number;
|
|
2050
|
-
/** Global tax rate for the project. Note that certain elements may have a different, specific tax rate. */
|
|
2051
1266
|
taxRate: number;
|
|
2052
|
-
/** This property indicates if the TaxRate property is actually zero (0) or if it's just unset. The TaxRate is a non-nullable property, so it can't be null and therefore a distinction between unset and zero relies on this additional property. When exporting to GAEB, this can be used e.g. to decide whether or not the tax rate should be serialized. This property is automtically set to false when the TaxRate is set to any value, even zero. If the TaxRate is not set to zero, this property will always return false and can not be set to true. */
|
|
2053
1267
|
hasUnsetTaxRate: boolean;
|
|
2054
|
-
/** Trade discounts for offered in this ServiceSpecification. */
|
|
2055
1268
|
tradeDiscounts?: ITradeDiscountDto[] | undefined;
|
|
2056
1269
|
}
|
|
2057
|
-
/** This class holds information about offered trade discounts (Skonto in German) */
|
|
2058
1270
|
declare class TradeDiscountDto implements ITradeDiscountDto {
|
|
2059
|
-
/** Elements GUID identifier. */
|
|
2060
1271
|
id: string;
|
|
2061
|
-
/** The amount of days for how long a declared trade discount applies. Must be a positive number, negative values will be ignored and not set. */
|
|
2062
1272
|
deadline: number;
|
|
2063
|
-
/** The rate of the trade discount. */
|
|
2064
1273
|
rate: number;
|
|
2065
1274
|
constructor(data?: ITradeDiscountDto);
|
|
2066
1275
|
init?(_data?: any): void;
|
|
2067
1276
|
static fromJS(data: any): TradeDiscountDto;
|
|
2068
1277
|
toJSON?(data?: any): any;
|
|
2069
1278
|
}
|
|
2070
|
-
/** This class holds information about offered trade discounts (Skonto in German) */
|
|
2071
1279
|
interface ITradeDiscountDto {
|
|
2072
|
-
/** Elements GUID identifier. */
|
|
2073
1280
|
id: string;
|
|
2074
|
-
/** The amount of days for how long a declared trade discount applies. Must be a positive number, negative values will be ignored and not set. */
|
|
2075
1281
|
deadline: number;
|
|
2076
|
-
/** The rate of the trade discount. */
|
|
2077
1282
|
rate: number;
|
|
2078
1283
|
}
|
|
2079
|
-
/** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
|
|
2080
1284
|
declare class SustainabilityCatalogueDto implements ISustainabilityCatalogueDto {
|
|
2081
|
-
/** Elements GUID identifier. */
|
|
2082
1285
|
id: string;
|
|
2083
|
-
/** The key must be a unique identifier for the sustainability catalogue. It is used to link sustainability data in positions to a catalogue. The Dangl.AVA module does not enforce uniqueness, but it is recommended to use a unique key for each catalogue. */
|
|
2084
1286
|
key?: string | undefined;
|
|
2085
|
-
/** The description property can be used to provide further information about the sustainability catalogue. */
|
|
2086
1287
|
description?: string | undefined;
|
|
2087
1288
|
constructor(data?: ISustainabilityCatalogueDto);
|
|
2088
1289
|
init?(_data?: any): void;
|
|
2089
1290
|
static fromJS(data: any): SustainabilityCatalogueDto;
|
|
2090
1291
|
toJSON?(data?: any): any;
|
|
2091
1292
|
}
|
|
2092
|
-
/** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
|
|
2093
1293
|
interface ISustainabilityCatalogueDto {
|
|
2094
|
-
/** Elements GUID identifier. */
|
|
2095
1294
|
id: string;
|
|
2096
|
-
/** The key must be a unique identifier for the sustainability catalogue. It is used to link sustainability data in positions to a catalogue. The Dangl.AVA module does not enforce uniqueness, but it is recommended to use a unique key for each catalogue. */
|
|
2097
1295
|
key?: string | undefined;
|
|
2098
|
-
/** The description property can be used to provide further information about the sustainability catalogue. */
|
|
2099
1296
|
description?: string | undefined;
|
|
2100
1297
|
}
|
|
2101
|
-
/** This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months */
|
|
2102
1298
|
declare class WarrantyDurationDto implements IWarrantyDurationDto {
|
|
2103
|
-
/** The scalar value of the duration. This value must be equal to or bigger than zero (>= 0). Negative values can not be set and will be ignored. */
|
|
2104
1299
|
duration: number;
|
|
2105
|
-
|
|
2106
|
-
unit: DurationUnitDto;
|
|
1300
|
+
unit?: DurationUnitDto | undefined;
|
|
2107
1301
|
constructor(data?: IWarrantyDurationDto);
|
|
2108
1302
|
init?(_data?: any): void;
|
|
2109
1303
|
static fromJS(data: any): WarrantyDurationDto;
|
|
2110
1304
|
toJSON?(data?: any): any;
|
|
2111
1305
|
}
|
|
2112
|
-
/** This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months */
|
|
2113
1306
|
interface IWarrantyDurationDto {
|
|
2114
|
-
/** The scalar value of the duration. This value must be equal to or bigger than zero (>= 0). Negative values can not be set and will be ignored. */
|
|
2115
1307
|
duration: number;
|
|
2116
|
-
|
|
2117
|
-
unit: DurationUnitDto;
|
|
1308
|
+
unit?: DurationUnitDto | undefined;
|
|
2118
1309
|
}
|
|
2119
|
-
/** This enumeration represents the unit of a duration */
|
|
2120
1310
|
declare enum DurationUnitDto {
|
|
2121
1311
|
Months = "Months",
|
|
2122
1312
|
Years = "Years"
|
|
2123
1313
|
}
|
|
2124
|
-
/** This class represents properties used in commerce exchange scenarios */
|
|
2125
1314
|
declare class ServiceSpecificationCommercePropertiesDto implements IServiceSpecificationCommercePropertiesDto {
|
|
2126
|
-
/** The date until the price is valid or fixed. */
|
|
2127
1315
|
fixedPriceDate?: Date | undefined;
|
|
2128
|
-
/** The date of the delivery voucher note. */
|
|
2129
1316
|
deliveryVoucherDate?: Date | undefined;
|
|
2130
|
-
/** The actual date of delivery. */
|
|
2131
1317
|
deliveryDate?: Date | undefined;
|
|
2132
|
-
/** The number of the inquiry, usually in a context of offer requests. */
|
|
2133
1318
|
inquiryNumber?: string | undefined;
|
|
2134
|
-
/** The number of the offer, usually in a context of an offer. */
|
|
2135
1319
|
offerNumber?: string | undefined;
|
|
2136
|
-
/** The order number, usually in the context of a grant or contract. */
|
|
2137
1320
|
orderNumber?: string | undefined;
|
|
2138
|
-
/** The order confirmation number */
|
|
2139
1321
|
orderConfirmationNumber?: string | undefined;
|
|
2140
|
-
/** The number of the delivery, e.g. on the delivery note voucher. */
|
|
2141
1322
|
deliveryNumber?: string | undefined;
|
|
2142
|
-
/** The reference number of the customer / buyer. */
|
|
2143
1323
|
customerReferenceNumber?: string | undefined;
|
|
2144
|
-
/** The reference number of the supplier / bidder. */
|
|
2145
1324
|
supplierReferenceNumber?: string | undefined;
|
|
2146
|
-
/** The type of shippment. */
|
|
2147
1325
|
shippingType?: string | undefined;
|
|
2148
|
-
|
|
2149
|
-
inquiryType: CommerceInquiryTypeDto;
|
|
1326
|
+
inquiryType?: CommerceInquiryTypeDto | undefined;
|
|
2150
1327
|
constructor(data?: IServiceSpecificationCommercePropertiesDto);
|
|
2151
1328
|
init?(_data?: any): void;
|
|
2152
1329
|
static fromJS(data: any): ServiceSpecificationCommercePropertiesDto;
|
|
2153
1330
|
toJSON?(data?: any): any;
|
|
2154
1331
|
}
|
|
2155
|
-
/** This class represents properties used in commerce exchange scenarios */
|
|
2156
1332
|
interface IServiceSpecificationCommercePropertiesDto {
|
|
2157
|
-
/** The date until the price is valid or fixed. */
|
|
2158
1333
|
fixedPriceDate?: Date | undefined;
|
|
2159
|
-
/** The date of the delivery voucher note. */
|
|
2160
1334
|
deliveryVoucherDate?: Date | undefined;
|
|
2161
|
-
/** The actual date of delivery. */
|
|
2162
1335
|
deliveryDate?: Date | undefined;
|
|
2163
|
-
/** The number of the inquiry, usually in a context of offer requests. */
|
|
2164
1336
|
inquiryNumber?: string | undefined;
|
|
2165
|
-
/** The number of the offer, usually in a context of an offer. */
|
|
2166
1337
|
offerNumber?: string | undefined;
|
|
2167
|
-
/** The order number, usually in the context of a grant or contract. */
|
|
2168
1338
|
orderNumber?: string | undefined;
|
|
2169
|
-
/** The order confirmation number */
|
|
2170
1339
|
orderConfirmationNumber?: string | undefined;
|
|
2171
|
-
/** The number of the delivery, e.g. on the delivery note voucher. */
|
|
2172
1340
|
deliveryNumber?: string | undefined;
|
|
2173
|
-
/** The reference number of the customer / buyer. */
|
|
2174
1341
|
customerReferenceNumber?: string | undefined;
|
|
2175
|
-
/** The reference number of the supplier / bidder. */
|
|
2176
1342
|
supplierReferenceNumber?: string | undefined;
|
|
2177
|
-
/** The type of shippment. */
|
|
2178
1343
|
shippingType?: string | undefined;
|
|
2179
|
-
|
|
2180
|
-
inquiryType: CommerceInquiryTypeDto;
|
|
1344
|
+
inquiryType?: CommerceInquiryTypeDto | undefined;
|
|
2181
1345
|
}
|
|
2182
|
-
/** This enum represents types of price inquiries */
|
|
2183
1346
|
declare enum CommerceInquiryTypeDto {
|
|
2184
1347
|
Unknown = "Unknown",
|
|
2185
1348
|
Project = "Project",
|
|
2186
1349
|
Immediate = "Immediate",
|
|
2187
1350
|
Exhibition = "Exhibition"
|
|
2188
1351
|
}
|
|
2189
|
-
/** A Project contains all relevant information for a construction project. */
|
|
2190
1352
|
declare class ProjectDto implements IProjectDto {
|
|
2191
|
-
/** Elements GUID identifier. */
|
|
2192
1353
|
id: string;
|
|
2193
|
-
/** This property controls the accuracy of all price properties, meaning how many decimal places are preserved in calculations. It defaults to DEFAULT_PRICE_ACCURACY. Please see the Dangl.AVA documentation for further information about decimal precision. If UnitPriceAccuracy is set, then this property is ignored for unit prices. */
|
|
2194
1354
|
priceAccuracy: number;
|
|
2195
|
-
/** This property controls the accuracy of position unit price properties, meaning how many decimal places are preserved in calculations. Please see the Dangl.AVA documentation for further information about decimal precision. This can be separately set from PriceAccuracy, and it only controls the accuracy of the unit price of positions, not the total price. It defaults to null, which means the standard PriceAccuracy is used for unit prices. */
|
|
2196
1355
|
unitPriceAccuracy?: number | undefined;
|
|
2197
|
-
/** This forces total prices to be the strict product of quantities times unit price in positions. It is enabled by default. If this is disabled, both the unit price and the total price of positions is calculated from the non-rounded values. Please see the documentation for a more detailed explanation of this setting. */
|
|
2198
1356
|
forceStrictTotals: boolean;
|
|
2199
|
-
|
|
2200
|
-
priceRoundingMode: PriceRoundingModeDto;
|
|
2201
|
-
/** The ProjectInformation contains information that describes the project and its structure. */
|
|
1357
|
+
priceRoundingMode?: PriceRoundingModeDto | undefined;
|
|
2202
1358
|
projectInformation?: ProjectInformationDto | undefined;
|
|
2203
|
-
/** The ServiceSpecifications in this Project. */
|
|
2204
1359
|
serviceSpecifications?: ServiceSpecificationDto[] | undefined;
|
|
2205
|
-
/** This is used to store the GAEB XML Id within this Project. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
2206
1360
|
gaebXmlId?: string | undefined;
|
|
2207
1361
|
constructor(data?: IProjectDto);
|
|
2208
1362
|
init?(_data?: any): void;
|
|
2209
1363
|
static fromJS(data: any): ProjectDto;
|
|
2210
1364
|
toJSON?(data?: any): any;
|
|
2211
1365
|
}
|
|
2212
|
-
/** A Project contains all relevant information for a construction project. */
|
|
2213
1366
|
interface IProjectDto {
|
|
2214
|
-
/** Elements GUID identifier. */
|
|
2215
1367
|
id: string;
|
|
2216
|
-
/** This property controls the accuracy of all price properties, meaning how many decimal places are preserved in calculations. It defaults to DEFAULT_PRICE_ACCURACY. Please see the Dangl.AVA documentation for further information about decimal precision. If UnitPriceAccuracy is set, then this property is ignored for unit prices. */
|
|
2217
1368
|
priceAccuracy: number;
|
|
2218
|
-
/** This property controls the accuracy of position unit price properties, meaning how many decimal places are preserved in calculations. Please see the Dangl.AVA documentation for further information about decimal precision. This can be separately set from PriceAccuracy, and it only controls the accuracy of the unit price of positions, not the total price. It defaults to null, which means the standard PriceAccuracy is used for unit prices. */
|
|
2219
1369
|
unitPriceAccuracy?: number | undefined;
|
|
2220
|
-
/** This forces total prices to be the strict product of quantities times unit price in positions. It is enabled by default. If this is disabled, both the unit price and the total price of positions is calculated from the non-rounded values. Please see the documentation for a more detailed explanation of this setting. */
|
|
2221
1370
|
forceStrictTotals: boolean;
|
|
2222
|
-
|
|
2223
|
-
priceRoundingMode: PriceRoundingModeDto;
|
|
2224
|
-
/** The ProjectInformation contains information that describes the project and its structure. */
|
|
1371
|
+
priceRoundingMode?: PriceRoundingModeDto | undefined;
|
|
2225
1372
|
projectInformation?: IProjectInformationDto | undefined;
|
|
2226
|
-
/** The ServiceSpecifications in this Project. */
|
|
2227
1373
|
serviceSpecifications?: IServiceSpecificationDto[] | undefined;
|
|
2228
|
-
/** This is used to store the GAEB XML Id within this Project. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
|
|
2229
1374
|
gaebXmlId?: string | undefined;
|
|
2230
1375
|
}
|
|
2231
1376
|
|