Skip to content

Commit 1dac213

Browse files
Merge pull request #104 from aspose-tasks/tasks-java-api-25.4
Updated API for Aspose.Tasks for Java 25.4
2 parents 061e176 + cf35371 commit 1dac213

File tree

204 files changed

+662
-251
lines changed

Some content is hidden

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

204 files changed

+662
-251
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ url: /java/com.aspose.tasks/
179179
| [OutlineValueType](../com.aspose.tasks/outlinevaluetype) | Specifies the type of an outline value. |
180180
| [PageInfo](../com.aspose.tasks/pageinfo) | Represents page setup data which is present in MPP file format and used for printing. |
181181
| [PageLegend](../com.aspose.tasks/pagelegend) | Represents a page legend which is used for project printing. |
182+
| [PageLegendItem](../com.aspose.tasks/pagelegenditem) | Represents an item of page legend of Gantt chart. |
182183
| [PageMargins](../com.aspose.tasks/pagemargins) | Represents page margins for printing. |
183184
| [PageSavingArgs](../com.aspose.tasks/pagesavingargs) | This class represents set of data that related to saving of document's page to a stream. |
184185
| [PageSettings](../com.aspose.tasks/pagesettings) | Represents printing settings for a page of project view. |
@@ -375,6 +376,7 @@ url: /java/com.aspose.tasks/
375376
| [AssignmentToColumnTextConverter](../com.aspose.tasks/assignmenttocolumntextconverter) | ResourceAssignment data to column's string converter. |
376377
| [Event<TArgs>](../com.aspose.tasks/event) | An event. |
377378
| [IAlgorithm<T>](../com.aspose.tasks/ialgorithm) | Represents an algorithm that can be applied to a list of objects `T`. |
379+
| [ICalendar](../com.aspose.tasks/icalendar) | Represents a calendar abstraction which can be used for various calculations of dates and durations. |
378380
| [ICondition<T>](../com.aspose.tasks/icondition) | Represents a condition which can be used by filters or search methods. |
379381
| [ICssSavingCallback](../com.aspose.tasks/icsssavingcallback) | Represents a callback that is called to create resource to store CSS. |
380382
| [IFontSavingCallback](../com.aspose.tasks/ifontsavingcallback) | Represents a callback that is called to create resource to store fonts. |

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: 364
6+
weight: 365
77
url: /java/com.aspose.tasks/assignmenttocolumntextconverter/
88
---
99
```

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

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@ url: /java/com.aspose.tasks/calendar/
99

1010
**Inheritance:**
1111
java.lang.Object
12+
13+
**All Implemented Interfaces:**
14+
[com.aspose.tasks.ICalendar](../../com.aspose.tasks/icalendar)
1215
```
13-
public class Calendar
16+
public class Calendar implements ICalendar
1417
```
1518

1619
Represents a calendar used in a project.
@@ -61,22 +64,23 @@ Calendars are used to define standard working and non-working times. Projects mu
6164
| [getFinishDateByStartAndWork(Date start, Duration work)](#getFinishDateByStartAndWork-java.util.Date-com.aspose.tasks.Duration-) | Calculates the date when the specified amount of work time will pass according to the calendar. |
6265
| [getFinishDateByStartAndWork(Date start, double work)](#getFinishDateByStartAndWork-java.util.Date-double-) | Calculates the date when the specified amount of work time will pass according to the calendar. |
6366
| [getGuid()](#getGuid--) | Gets calendar's Guid. |
67+
| [getIntersectionCalendar(Calendar calendar1, Calendar calendar2)](#getIntersectionCalendar-com.aspose.tasks.Calendar-com.aspose.tasks.Calendar-) | Gets [ICalendar](../../com.aspose.tasks/icalendar) instance which can be used to perform calculations on the intersection of work schedules of 2 calendars. |
6468
| [getName()](#getName--) | Gets the name of the calendar. |
65-
| [getNextWorkingDayStart(Date date)](#getNextWorkingDayStart-java.util.Date-) | Calculates next working day start from the date. |
66-
| [getPreviousWorkingDayEnd(Date date)](#getPreviousWorkingDayEnd-java.util.Date-) | Calculates previous working date end from the specified date. |
67-
| [getStartDateFromFinishAndDuration(Date finish, Duration duration)](#getStartDateFromFinishAndDuration-java.util.Date-com.aspose.tasks.Duration-) | Returns StartDate based on specified FinishDate and Duration. |
68-
| [getStartDateFromFinishAndDuration(Date finish, double duration)](#getStartDateFromFinishAndDuration-java.util.Date-double-) | Returns StartDate based on specified FinishDate and Duration. |
69-
| [getTaskFinishDateFromDuration(Task task, double duration)](#getTaskFinishDateFromDuration-com.aspose.tasks.Task-double-) | Calculates the task finish date and time from its start date, split parts and the duration. |
69+
| [getNextWorkingDayStart(Date date)](#getNextWorkingDayStart-java.util.Date-) | Calculates next working day start for the specified date. |
70+
| [getPreviousWorkingDayEnd(Date date)](#getPreviousWorkingDayEnd-java.util.Date-) | Calculates the end of the previous working date from the specified date. |
71+
| [getStartDateFromFinishAndDuration(Date finish, Duration duration)](#getStartDateFromFinishAndDuration-java.util.Date-com.aspose.tasks.Duration-) | Returns start date based on the specified finish date and duration. |
72+
| [getStartDateFromFinishAndDuration(Date finish, double duration)](#getStartDateFromFinishAndDuration-java.util.Date-double-) | Returns start date based on specified finish date and duration. |
73+
| [getTaskFinishDateFromDuration(Task task, double duration)](#getTaskFinishDateFromDuration-com.aspose.tasks.Task-double-) | Calculates the task finish date and time from its start date, split parts and the work duration. |
7074
| [getUid()](#getUid--) | Gets the unique identifier of the calendar. |
7175
| [getWeekDays()](#getWeekDays--) | Gets WeekDaysCollection for this calendar. |
7276
| [getWorkWeeks()](#getWorkWeeks--) | Gets WorkWeekCollections object. |
73-
| [getWorkingHours(Date dt)](#getWorkingHours-java.util.Date-) | Returns amount of working hours at the date. |
74-
| [getWorkingHours(Date start, Date finish)](#getWorkingHours-java.util.Date-java.util.Date-) | Return working hours for the specified dates. |
77+
| [getWorkingHours(Date dt)](#getWorkingHours-java.util.Date-) | Returns the amount of working hours at the specified date. |
78+
| [getWorkingHours(Date start, Date finish)](#getWorkingHours-java.util.Date-java.util.Date-) | Return WorkUnit - Start, Finish and Duration of working hours for the specified date time interval. |
7579
| [getWorkingTimes(Date dt)](#getWorkingTimes-java.util.Date-) | Returns [WorkingTimeCollection](../../com.aspose.tasks/workingtimecollection) of working times for the specified date. |
7680
| [hashCode()](#hashCode--) | Returns a hash code for the instance of the class. |
7781
| [isBaseCalendar()](#isBaseCalendar--) | Gets a value indicating whether the calendar is a base calendar. |
7882
| [isBaselineCalendar()](#isBaselineCalendar--) | Gets a value indicating whether the calendar is a baseline calendar. |
79-
| [isDayWorking(Date dt)](#isDayWorking-java.util.Date-) | Determines whether the day is working day. |
83+
| [isDayWorking(Date dt)](#isDayWorking-java.util.Date-) | Determines whether the specified day is a working day according to the calendar. |
8084
| [make24HourCalendar(Calendar calendar)](#make24HourCalendar-com.aspose.tasks.Calendar-) | Makes a given Calendar to be a 24Hour Calendar. 24Hours Calendar is a Calendar in which every day of week is working with Round-the-clock working hours. |
8185
| [makeNightShiftCalendar(Calendar calendar)](#makeNightShiftCalendar-com.aspose.tasks.Calendar-) | Makes a given Calendar as Night Shift Calendar. |
8286
| [makeStandardCalendar(Calendar calendar)](#makeStandardCalendar-com.aspose.tasks.Calendar-) | Creates default standard calendar. |
@@ -169,6 +173,22 @@ Gets calendar's Guid.
169173
170174
**Returns:**
171175
java.lang.String - calendar's Guid.
176+
### getIntersectionCalendar(Calendar calendar1, Calendar calendar2) {#getIntersectionCalendar-com.aspose.tasks.Calendar-com.aspose.tasks.Calendar-}
177+
```
178+
public static ICalendar getIntersectionCalendar(Calendar calendar1, Calendar calendar2)
179+
```
180+
181+
182+
Gets [ICalendar](../../com.aspose.tasks/icalendar) instance which can be used to perform calculations on the intersection of work schedules of 2 calendars.
183+
184+
**Parameters:**
185+
| Parameter | Type | Description |
186+
| --- | --- | --- |
187+
| calendar1 | [Calendar](../../com.aspose.tasks/calendar) | First calendar. |
188+
| calendar2 | [Calendar](../../com.aspose.tasks/calendar) | Second calendar. |
189+
190+
**Returns:**
191+
[ICalendar](../../com.aspose.tasks/icalendar) - Implementation of ICalendar interface.
172192
### getName() {#getName--}
173193
```
174194
public final String getName()
@@ -185,7 +205,7 @@ public final Date getNextWorkingDayStart(Date date)
185205
```
186206
187207
188-
Calculates next working day start from the date.
208+
Calculates next working day start for the specified date.
189209
190210
**Parameters:**
191211
| Parameter | Type | Description |
@@ -200,67 +220,65 @@ public final Date getPreviousWorkingDayEnd(Date date)
200220
```
201221
202222
203-
Calculates previous working date end from the specified date.
223+
Calculates the end of the previous working date from the specified date.
204224
205225
**Parameters:**
206226
| Parameter | Type | Description |
207227
| --- | --- | --- |
208228
| date | java.util.Date | the specified instance of java.util.Date struct. |
209229
210230
**Returns:**
211-
java.util.Date - Previous working day start java.util.Date
231+
java.util.Date - The end of the previous working day end java.util.Date
212232
### getStartDateFromFinishAndDuration(Date finish, Duration duration) {#getStartDateFromFinishAndDuration-java.util.Date-com.aspose.tasks.Duration-}
213233
```
214234
public final Date getStartDateFromFinishAndDuration(Date finish, Duration duration)
215235
```
216236
217237
218-
Returns StartDate based on specified FinishDate and Duration.
238+
Returns start date based on the specified finish date and duration.
219239
220240
**Parameters:**
221241
| Parameter | Type | Description |
222242
| --- | --- | --- |
223243
| finish | java.util.Date | The specified finish date. |
224-
| duration | [Duration](../../com.aspose.tasks/duration) | The specified work duration. |
244+
| duration | [Duration](../../com.aspose.tasks/duration) | The specified duration. |
225245
226246
**Returns:**
227-
java.util.Date - Calculated StartDate.
247+
java.util.Date - Calculated start date.
228248
### getStartDateFromFinishAndDuration(Date finish, double duration) {#getStartDateFromFinishAndDuration-java.util.Date-double-}
229249
```
230250
public final Date getStartDateFromFinishAndDuration(Date finish, double duration)
231251
```
232252
233253
234-
Returns StartDate based on specified FinishDate and Duration.
254+
Returns start date based on specified finish date and duration.
235255
236256
**Parameters:**
237257
| Parameter | Type | Description |
238258
| --- | --- | --- |
239259
| finish | java.util.Date | The specified finish date. |
240-
| duration | double | The specified work duration. |
260+
| duration | double | The specified duration. |
241261
242262
**Returns:**
243-
java.util.Date - Calculated StartDate.
263+
java.util.Date - Calculated start date.
244264
### getTaskFinishDateFromDuration(Task task, double duration) {#getTaskFinishDateFromDuration-com.aspose.tasks.Task-double-}
245265
```
246266
public final Date getTaskFinishDateFromDuration(Task task, double duration)
247267
```
248268
249269
250-
Calculates the task finish date and time from its start date, split parts and the duration.
270+
Calculates the task finish date and time from its start date, split parts and the work duration.
251271
252272
**Parameters:**
253273
| Parameter | Type | Description |
254274
| --- | --- | --- |
255-
| task | [Task](../../com.aspose.tasks/task) | The task to get finish date for. |
256-
| duration | double | The task duration to split on.
257-
258-
--------------------
275+
| task | [Task](../../com.aspose.tasks/task) | The task to calculate finish date for. |
276+
| duration | double | The duration to calculate.
259277
260278
Returns DateTime.MinValue if task is summary, null or its start date is not set. |
261279
262280
**Returns:**
263-
java.util.Date - Task's finish date.
281+
java.util.Date - Task's finish date for the given start date and duration.
264282
### getUid() {#getUid--}
265283
```
266284
public final int getUid()
@@ -297,31 +315,31 @@ public final double getWorkingHours(Date dt)
297315
```
298316
299317
300-
Returns amount of working hours at the date.
318+
Returns the amount of working hours at the specified date.
301319
302320
**Parameters:**
303321
| Parameter | Type | Description |
304322
| --- | --- | --- |
305323
| dt | java.util.Date | The date to get working hours for. |
306324
307325
**Returns:**
308-
double - Working hours.
326+
double - Working hours at the specified date.
309327
### getWorkingHours(Date start, Date finish) {#getWorkingHours-java.util.Date-java.util.Date-}
310328
```
311329
public final WorkUnit getWorkingHours(Date start, Date finish)
312330
```
313331
314332
315-
Return working hours for the specified dates.
333+
Return WorkUnit - Start, Finish and Duration of working hours for the specified date time interval.
316334
317335
**Parameters:**
318336
| Parameter | Type | Description |
319337
| --- | --- | --- |
320-
| start | java.util.Date | Start date. |
321-
| finish | java.util.Date | Finish date. |
338+
| start | java.util.Date | Start date of the interval. |
339+
| finish | java.util.Date | Finish date of the interval. |
322340
323341
**Returns:**
324-
[WorkUnit](../../com.aspose.tasks/workunit) - Working hours.
342+
[WorkUnit](../../com.aspose.tasks/workunit) - Instance of [WorkUnit](../../com.aspose.tasks/workunit) class containing Start, Finish and Duration of working hours.
325343
### getWorkingTimes(Date dt) {#getWorkingTimes-java.util.Date-}
326344
```
327345
public final WorkingTimeCollection getWorkingTimes(Date dt)
@@ -336,7 +354,7 @@ Returns [WorkingTimeCollection](../../com.aspose.tasks/workingtimecollection) of
336354
| dt | java.util.Date | The date to get working times for. |
337355
338356
**Returns:**
339-
[WorkingTimeCollection](../../com.aspose.tasks/workingtimecollection) - List of [WorkingTime](../../com.aspose.tasks/workingtime).
357+
[WorkingTimeCollection](../../com.aspose.tasks/workingtimecollection) - Collection of [WorkingTime](../../com.aspose.tasks/workingtime) instances.
340358
### hashCode() {#hashCode--}
341359
```
342360
public int hashCode()
@@ -373,15 +391,15 @@ public final boolean isDayWorking(Date dt)
373391
```
374392
375393
376-
Determines whether the day is working day.
394+
Determines whether the specified day is a working day according to the calendar.
377395
378396
**Parameters:**
379397
| Parameter | Type | Description |
380398
| --- | --- | --- |
381-
| dt | java.util.Date | The date to check day is working for. |
399+
| dt | java.util.Date | The date to check whether the day is working. |
382400
383401
**Returns:**
384-
boolean - True if the day is working day.
402+
boolean - True if the day is a working day.
385403
### make24HourCalendar(Calendar calendar) {#make24HourCalendar-com.aspose.tasks.Calendar-}
386404
```
387405
public static Calendar make24HourCalendar(Calendar calendar)

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: 365
6+
weight: 366
77
url: /java/com.aspose.tasks/event/
88
---
99
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: IAlgorithm
33
second_title: Aspose.Tasks for Java API Reference
44
description: Represents an algorithm that can be applied to a list of objects T.
55
type: docs
6-
weight: 366
6+
weight: 367
77
url: /java/com.aspose.tasks/ialgorithm/
88
---
99
```

0 commit comments

Comments
 (0)