Skip to content

Commit 0642418

Browse files
VadimYurkoVadimYurko
committed
Updated Aspose.Tasks for Java API reference to v.24.10.
1 parent a4857e1 commit 0642418

File tree

266 files changed

+839
-317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+839
-317
lines changed

‎english/java/com.aspose.tasks/_index.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ url: /java/com.aspose.tasks/
9595
| [FillPattern](../com.aspose.tasks/fillpattern) | Fill pattern used in middle shape of a gantt bar. |
9696
| [Filter](../com.aspose.tasks/filter) | Represents a filter in Project. |
9797
| [FilterCollection](../com.aspose.tasks/filtercollection) | Contains a list of [Filter](../com.aspose.tasks/filter) objects. |
98-
| [FilterComparisonType](../com.aspose.tasks/filtercomparisontype) | The type of comparison made between FieldName and Value that acts as selection criteria for the filter. |
98+
| [FilterComparisonType](../com.aspose.tasks/filtercomparisontype) | The type of comparison made between FieldName and Value that acts as selection criteria for a filter or graphical indicator. |
9999
| [FilterCriteria](../com.aspose.tasks/filtercriteria) | Defines the criteria that tasks or resources must meet to be displayed in MSP view. |
100100
| [FilterOperation](../com.aspose.tasks/filteroperation) | Specifies how the criterion established with FieldName, FilterComparisonType, and Value relates to other criteria in the filter. |
101101
| [FontDescriptor](../com.aspose.tasks/fontdescriptor) | Represents font information. |
@@ -116,6 +116,10 @@ url: /java/com.aspose.tasks/
116116
| [GanttChartColumn](../com.aspose.tasks/ganttchartcolumn) | Project's view class |
117117
| [GanttChartView](../com.aspose.tasks/ganttchartview) | Represents a GanttChart view. |
118118
| [GenericProperty<TKey>](../com.aspose.tasks/genericproperty) | Represents a container property. |
119+
| [GraphicalIndicatorCriteria](../com.aspose.tasks/graphicalindicatorcriteria) | Represents one graphical indicator criteria associated with an extended attribute. |
120+
| [GraphicalIndicatorCriteriaType](../com.aspose.tasks/graphicalindicatorcriteriatype) | Represents placement of graphical indicator criteria. |
121+
| [GraphicalIndicatorCriteriaValue](../com.aspose.tasks/graphicalindicatorcriteriavalue) | Represents a value used in condition check of graphical indicators criteria. |
122+
| [GraphicalIndicatorsInfo](../com.aspose.tasks/graphicalindicatorsinfo) | Represents an graphical indicators definition associated with an extended attribute. |
119123
| [Gridline](../com.aspose.tasks/gridline) | The horizontal or vertical line that appears in the project view. |
120124
| [GridlineType](../com.aspose.tasks/gridlinetype) | Type of gridline. |
121125
| [Gridlines](../com.aspose.tasks/gridlines) | Represents gridlines that appear in a GanttChart view. |
@@ -253,6 +257,7 @@ url: /java/com.aspose.tasks/
253257
| [ResourceUsageView](../com.aspose.tasks/resourceusageview) | Represents resource usage view in a project. |
254258
| [ResourceUsageViewField](../com.aspose.tasks/resourceusageviewfield) | Represents possible fields in [ResourceUsageView](../com.aspose.tasks/resourceusageview) object resource usage view field. |
255259
| [ResourceUsageViewFieldCollection](../com.aspose.tasks/resourceusageviewfieldcollection) | Represent a collection of `ResourceUsageViewField` values. |
260+
| [ResourceValidationException](../com.aspose.tasks/resourcevalidationexception) | Represents an exception which is thrown when errors are found in resource's properties. |
256261
| [ResourceViewColumn](../com.aspose.tasks/resourceviewcolumn) | Project's view class used in ResourceUsage view and ResourceSheet view. |
257262
| [RiskAnalysisResult](../com.aspose.tasks/riskanalysisresult) | Represents a result of risk analysis. |
258263
| [RiskAnalysisSettings](../com.aspose.tasks/riskanalysissettings) | Specifies settings for performing risk analysis. |

‎english/java/com.aspose.tasks/assignmenttocolumntextconverter/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: AssignmentToColumnTextConverter
33
second_title: Aspose.Tasks for Java API Reference
44
description: ResourceAssignment data to columns string converter.
55
type: docs
6-
weight: 358
6+
weight: 363
77
url: /java/com.aspose.tasks/assignmenttocolumntextconverter/
88
---
99
```

‎english/java/com.aspose.tasks/availabilityperiod/_index.md‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Represents a period when a resource is available.
1818

1919
| Constructor | Description |
2020
| --- | --- |
21-
| [AvailabilityPeriod()](#AvailabilityPeriod--) | |
21+
| [AvailabilityPeriod()](#AvailabilityPeriod--) | Initializes a new instance of the [AvailabilityPeriod](../../com.aspose.tasks/availabilityperiod). |
22+
| [AvailabilityPeriod(Date availableFrom, Date availableTo, double availableUnits)](#AvailabilityPeriod-java.util.Date-java.util.Date-double-) | Initializes a new instance of the [AvailabilityPeriod](../../com.aspose.tasks/availabilityperiod) with the specified date range and available units. |
2223
## Methods
2324

2425
| Method | Description |
@@ -35,6 +36,23 @@ public AvailabilityPeriod()
3536
```
3637

3738

39+
Initializes a new instance of the [AvailabilityPeriod](../../com.aspose.tasks/availabilityperiod).
40+
41+
### AvailabilityPeriod(Date availableFrom, Date availableTo, double availableUnits) {#AvailabilityPeriod-java.util.Date-java.util.Date-double-}
42+
```
43+
public AvailabilityPeriod(Date availableFrom, Date availableTo, double availableUnits)
44+
```
45+
46+
47+
Initializes a new instance of the [AvailabilityPeriod](../../com.aspose.tasks/availabilityperiod) with the specified date range and available units.
48+
49+
**Parameters:**
50+
| Parameter | Type | Description |
51+
| --- | --- | --- |
52+
| availableFrom | java.util.Date | the date from |
53+
| availableTo | java.util.Date | the date to |
54+
| availableUnits | double | available units |
55+
3856
### getAvailableFrom() {#getAvailableFrom--}
3957
```
4058
public final Date getAvailableFrom()

‎english/java/com.aspose.tasks/event/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Event
33
second_title: Aspose.Tasks for Java API Reference
44
description: An event.
55
type: docs
6-
weight: 359
6+
weight: 364
77
url: /java/com.aspose.tasks/event/
88
---
99
```

‎english/java/com.aspose.tasks/extendedattributedefinition/_index.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Represents an extended attribute definition associated with a project.
4747
| [getFieldId()](#getFieldId--) | Gets corresponds to the project id of a custom field. |
4848
| [getFieldName()](#getFieldName--) | Gets the name of a custom field. |
4949
| [getFormula()](#getFormula--) | Gets the formula that Microsoft Project uses to populate a custom task field. |
50+
| [getGraphicalIndicator()](#getGraphicalIndicator--) | Gets a graphical indicators info associated with the extended attribute. |
5051
| [getGuid()](#getGuid--) | Gets the Guid of a custom field. |
5152
| [getLookupUid()](#getLookupUid--) | Gets a Guid of the lookup table associated with a custom field. |
5253
| [getMaxMultiValues()](#getMaxMultiValues--) | Gets the maximum number of values you can set in a pick list. |
@@ -71,6 +72,7 @@ Represents an extended attribute definition associated with a project.
7172
| [setElementType(int value)](#setElementType-int-) | Sets the extended attribute is associated with a task, a resource or an assignment. |
7273
| [setFieldId(String value)](#setFieldId-java.lang.String-) | Sets corresponds to the project id of a custom field. |
7374
| [setFormula(String value)](#setFormula-java.lang.String-) | Sets the formula that Microsoft Project uses to populate a custom task field. |
75+
| [setGraphicalIndicator(GraphicalIndicatorsInfo value)](#setGraphicalIndicator-com.aspose.tasks.GraphicalIndicatorsInfo-) | Sets a graphical indicators info associated with the extended attribute. |
7476
| [setGuid(String value)](#setGuid-java.lang.String-) | Sets the Guid of a custom field. |
7577
| [setMaxMultiValues(int value)](#setMaxMultiValues-int-) | Sets the maximum number of values you can set in a pick list. |
7678
| [setPhoneticsAlias(String value)](#setPhoneticsAlias-java.lang.String-) | Sets the phonetic pronunciation of the alias of a custom field. |
@@ -662,6 +664,16 @@ Gets the formula that Microsoft Project uses to populate a custom task field.
662664

663665
**Returns:**
664666
java.lang.String - the formula that Microsoft Project uses to populate a custom task field.
667+
### getGraphicalIndicator() {#getGraphicalIndicator--}
668+
```
669+
public final GraphicalIndicatorsInfo getGraphicalIndicator()
670+
```
671+
672+
673+
Gets a graphical indicators info associated with the extended attribute.
674+
675+
**Returns:**
676+
[GraphicalIndicatorsInfo](../../com.aspose.tasks/graphicalindicatorsinfo) - a graphical indicators info associated with the extended attribute.
665677
### getGuid() {#getGuid--}
666678
```
667679
public final String getGuid()
@@ -992,6 +1004,19 @@ Sets the formula that Microsoft Project uses to populate a custom task field.
9921004
| --- | --- | --- |
9931005
| value | java.lang.String | the formula that Microsoft Project uses to populate a custom task field. |
9941006

1007+
### setGraphicalIndicator(GraphicalIndicatorsInfo value) {#setGraphicalIndicator-com.aspose.tasks.GraphicalIndicatorsInfo-}
1008+
```
1009+
public final void setGraphicalIndicator(GraphicalIndicatorsInfo value)
1010+
```
1011+
1012+
1013+
Sets a graphical indicators info associated with the extended attribute.
1014+
1015+
**Parameters:**
1016+
| Parameter | Type | Description |
1017+
| --- | --- | --- |
1018+
| value | [GraphicalIndicatorsInfo](../../com.aspose.tasks/graphicalindicatorsinfo) | a graphical indicators info associated with the extended attribute. |
1019+
9951020
### setGuid(String value) {#setGuid-java.lang.String-}
9961021
```
9971022
public final void setGuid(String value)

‎english/java/com.aspose.tasks/filtercomparisontype/_index.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FilterComparisonType
33
second_title: Aspose.Tasks for Java API Reference
4-
description: The type of comparison made between FieldName and Value that acts as selection criteria for the filter.
4+
description: The type of comparison made between FieldName and Value that acts as selection criteria for a filter or graphical indicator.
55
type: docs
66
weight: 93
77
url: /java/com.aspose.tasks/filtercomparisontype/
@@ -13,7 +13,7 @@ java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
1313
public final class FilterComparisonType extends System.Enum
1414
```
1515

16-
The type of comparison made between FieldName and Value that acts as selection criteria for the filter.
16+
The type of comparison made between FieldName and Value that acts as selection criteria for a filter or graphical indicator.
1717
## Fields
1818

1919
| Field | Description |
@@ -23,6 +23,7 @@ The type of comparison made between FieldName and Value that acts as selection c
2323
| [DoesNotContain](#DoesNotContain) | The value of Field does not contain Value. |
2424
| [DoesNotEqual](#DoesNotEqual) | The value of Field does not equal Value. |
2525
| [Equals](#Equals) | The value of Field equals Value. |
26+
| [IsAnyValue](#IsAnyValue) | 'Is any value' condition. |
2627
| [IsGreaterThan](#IsGreaterThan) | The value of Field is greater than Value. |
2728
| [IsGreaterThanOrEqualTo](#IsGreaterThanOrEqualTo) | The value of Field is greater than or equal to Value. |
2829
| [IsLessThan](#IsLessThan) | The value of Field is less than Value. |
@@ -71,6 +72,14 @@ public static final int Equals
7172

7273
The value of Field equals Value.
7374

75+
### IsAnyValue {#IsAnyValue}
76+
```
77+
public static final int IsAnyValue
78+
```
79+
80+
81+
'Is any value' condition. Applicable to graphical indicators.
82+
7483
### IsGreaterThan {#IsGreaterThan}
7584
```
7685
public static final int IsGreaterThan

‎english/java/com.aspose.tasks/graphicalindicatorcriteria/_index.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: GraphicalIndicatorCriteria
3+
second_title: Aspose.Tasks for Java API Reference
4+
description: Represents one graphical indicator criteria associated with an extended attribute.
5+
type: docs
6+
weight: 114
7+
url: /java/com.aspose.tasks/graphicalindicatorcriteria/
8+
---
9+
10+
**Inheritance:**
11+
java.lang.Object
12+
```
13+
public final class GraphicalIndicatorCriteria
14+
```
15+
16+
Represents one graphical indicator criteria associated with an extended attribute.
17+
## Constructors
18+
19+
| Constructor | Description |
20+
| --- | --- |
21+
| [GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value1, GraphicalIndicatorCriteriaValue value2)](#GraphicalIndicatorCriteria-int-int-int-com.aspose.tasks.GraphicalIndicatorCriteriaValue-com.aspose.tasks.GraphicalIndicatorCriteriaValue-) | Initializes a new instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) type. |
22+
| [GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value)](#GraphicalIndicatorCriteria-int-int-int-com.aspose.tasks.GraphicalIndicatorCriteriaValue-) | Initializes a new instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) type. |
23+
## Methods
24+
25+
| Method | Description |
26+
| --- | --- |
27+
| [getImageIndex()](#getImageIndex--) | Gets the index of the image to display when the field meets the criteria. |
28+
| [getRowType()](#getRowType--) | Gets the value of [GraphicalIndicatorCriteriaType](../../com.aspose.tasks/graphicalindicatorcriteriatype) enum which denotes for which rows the indicator is applied. |
29+
| [getTest()](#getTest--) | Gets the type of comparison made between extended attribute's value and Values that acts as a criteria for the application of the graphical indicator. |
30+
| [getValue1()](#getValue1--) | Gets the value used to test extended attribute's value. |
31+
| [getValue2()](#getValue2--) | Gets the second value used to test extended attribute's value in case of 'IsWithin' and 'IsNotWithin' comparison types. |
32+
| [toString()](#toString--) | Returns string representation of the instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) class. |
33+
### GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value1, GraphicalIndicatorCriteriaValue value2) {#GraphicalIndicatorCriteria-int-int-int-com.aspose.tasks.GraphicalIndicatorCriteriaValue-com.aspose.tasks.GraphicalIndicatorCriteriaValue-}
34+
```
35+
public GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value1, GraphicalIndicatorCriteriaValue value2)
36+
```
37+
38+
39+
Initializes a new instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) type.
40+
41+
**Parameters:**
42+
| Parameter | Type | Description |
43+
| --- | --- | --- |
44+
| rowType | int | value of [GraphicalIndicatorCriteriaType](../../com.aspose.tasks/graphicalindicatorcriteriatype) enum which denotes for which rows the indicator is applied |
45+
| test | int | value of [FilterComparisonType](../../com.aspose.tasks/filtercomparisontype) denoting the type of comparison performed by the criteria. |
46+
| imageIndex | int | the index of the image to display when the field meets the criteria |
47+
| value1 | [GraphicalIndicatorCriteriaValue](../../com.aspose.tasks/graphicalindicatorcriteriavalue) | values used in condition check. |
48+
| value2 | [GraphicalIndicatorCriteriaValue](../../com.aspose.tasks/graphicalindicatorcriteriavalue) | second value (end of interval) used in condition check in case of 'IsWithin' and 'IsNotWithing' conditions. |
49+
50+
### GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value) {#GraphicalIndicatorCriteria-int-int-int-com.aspose.tasks.GraphicalIndicatorCriteriaValue-}
51+
```
52+
public GraphicalIndicatorCriteria(int rowType, int test, int imageIndex, GraphicalIndicatorCriteriaValue value)
53+
```
54+
55+
56+
Initializes a new instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) type.
57+
58+
**Parameters:**
59+
| Parameter | Type | Description |
60+
| --- | --- | --- |
61+
| rowType | int | value of [GraphicalIndicatorCriteriaType](../../com.aspose.tasks/graphicalindicatorcriteriatype) enum which denotes for which rows the indicator is applied |
62+
| test | int | value of [FilterComparisonType](../../com.aspose.tasks/filtercomparisontype) denoting the type of comparison performed by the criteria. |
63+
| imageIndex | int | the index of the image to display when the field meets the criteria |
64+
| value | [GraphicalIndicatorCriteriaValue](../../com.aspose.tasks/graphicalindicatorcriteriavalue) | value used in condition check. |
65+
66+
### getImageIndex() {#getImageIndex--}
67+
```
68+
public final int getImageIndex()
69+
```
70+
71+
72+
Gets the index of the image to display when the field meets the criteria.
73+
74+
**Returns:**
75+
int - the index of the image to display when the field meets the criteria.
76+
### getRowType() {#getRowType--}
77+
```
78+
public final int getRowType()
79+
```
80+
81+
82+
Gets the value of [GraphicalIndicatorCriteriaType](../../com.aspose.tasks/graphicalindicatorcriteriatype) enum which denotes for which rows the indicator is applied.
83+
84+
**Returns:**
85+
int - the value of [GraphicalIndicatorCriteriaType](../../com.aspose.tasks/graphicalindicatorcriteriatype) enum which denotes for which rows the indicator is applied.
86+
### getTest() {#getTest--}
87+
```
88+
public final int getTest()
89+
```
90+
91+
92+
Gets the type of comparison made between extended attribute's value and Values that acts as a criteria for the application of the graphical indicator. [FilterComparisonType](../../com.aspose.tasks/filtercomparisontype)
93+
94+
**Returns:**
95+
int - the type of comparison made between extended attribute's value and Values that acts as a criteria for the application of the graphical indicator.
96+
### getValue1() {#getValue1--}
97+
```
98+
public final GraphicalIndicatorCriteriaValue getValue1()
99+
```
100+
101+
102+
Gets the value used to test extended attribute's value.
103+
104+
**Returns:**
105+
[GraphicalIndicatorCriteriaValue](../../com.aspose.tasks/graphicalindicatorcriteriavalue) - the value used to test extended attribute's value.
106+
### getValue2() {#getValue2--}
107+
```
108+
public final GraphicalIndicatorCriteriaValue getValue2()
109+
```
110+
111+
112+
Gets the second value used to test extended attribute's value in case of 'IsWithin' and 'IsNotWithin' comparison types.
113+
114+
**Returns:**
115+
[GraphicalIndicatorCriteriaValue](../../com.aspose.tasks/graphicalindicatorcriteriavalue) - the second value used to test extended attribute's value in case of 'IsWithin' and 'IsNotWithin' comparison types.
116+
### toString() {#toString--}
117+
```
118+
public String toString()
119+
```
120+
121+
122+
Returns string representation of the instance of the [GraphicalIndicatorCriteria](../../com.aspose.tasks/graphicalindicatorcriteria) class.
123+
124+
**Returns:**
125+
java.lang.String - string representation of this object.

‎english/java/com.aspose.tasks/graphicalindicatorcriteriatype/_index.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: GraphicalIndicatorCriteriaType
3+
second_title: Aspose.Tasks for Java API Reference
4+
description: Represents placement of graphical indicator criteria.
5+
type: docs
6+
weight: 115
7+
url: /java/com.aspose.tasks/graphicalindicatorcriteriatype/
8+
---
9+
10+
**Inheritance:**
11+
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
12+
```
13+
public final class GraphicalIndicatorCriteriaType extends System.Enum
14+
```
15+
16+
Represents placement of graphical indicator criteria.
17+
## Fields
18+
19+
| Field | Description |
20+
| --- | --- |
21+
| [NonSummaryRows](#NonSummaryRows) | Represents non summary rows. |
22+
| [ProjectSummary](#ProjectSummary) | Represents project summary task row. |
23+
| [SummaryRows](#SummaryRows) | Represents summary rows. |
24+
### NonSummaryRows {#NonSummaryRows}
25+
```
26+
public static final int NonSummaryRows
27+
```
28+
29+
30+
Represents non summary rows.
31+
32+
### ProjectSummary {#ProjectSummary}
33+
```
34+
public static final int ProjectSummary
35+
```
36+
37+
38+
Represents project summary task row.
39+
40+
### SummaryRows {#SummaryRows}
41+
```
42+
public static final int SummaryRows
43+
```
44+
45+
46+
Represents summary rows.
47+

0 commit comments

Comments
 (0)