DateTime.addWeek()

Signature

DateTime addWeek (DateTime date, int weeks)

Domain

action, condition

Description

Adds a number of weeks to a DateTime and returns the result. The input DateTime is not modified.

Parameters

NameTypeDescription
dateDateTimeA DateTime to add some amount of time to.
weeksintThe number of weeks to add to the DateTime.

Returns

TypeDescription
DateTimeA new DateTime that results from adding the number of time units to the date argument.

Cautions

none

Example


Date dateNow = Date.now ();
String start = DateTime.format (dateNow, "yyyy-MM-dd HH:mm:ss");
String result = DateTime.format (DateTime.addWeek(dateNow, 1), "yyyy-MM-dd HH:mm:ss");

Result is:
start contains: "2004-03-11 14:59:04"
result contains: "2004-03-18 14:59:04"