com.smartsheet.api.models

Class Schedule

java.lang.Object

com.smartsheet.api.models.Schedule

public class Schedule
extends Object

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
List<DayDescriptor>	getDayDescriptors() Get an array of day descriptors
Integer	getDayOfMonth() Get the day within the month
DayOrdinal	getDayOrdinal() Get the day ordinal
Date	getEndAt() Get the date, time and time zone at which the delivery schedule will end
Date	getLastSentAt() Get the date and time for when the last request was sent.
Date	getNextSendAt() Get the date and time for when the next request is scheduled to send.
Integer	getRepeatEvery() Get the frequency on which the request will be delivered.
Date	getStartAt() Get the date, time and time zone at which the first delivery will start
ScheduleType	getType() Get the schedule type
Schedule	sentNextSendAt(Date nextSendAt) Set the date and time for when the next request is schedule to send.
Schedule	setDayDescriptors(List<DayDescriptor> dayDescriptors) Set the array of day descriptors
Schedule	setDayOfMonth(Integer dayOfMonth) Set the day within the month
Schedule	setDayOrdinal(DayOrdinal dayOrdinal) Set the day ordinal
Schedule	setEndAt(Date endAt) Set the date, time and time zone at which the delivery schedule will end
Schedule	setLastSentAt(Date lastSentAt) Set the date and time for when the last request was sent.
Schedule	setRepeatEvery(Integer repeatEvery) Set the frequency on which the request will be delivered.
Schedule	setStartAt(Date startAt) Set the date, time and time zone at which the first delivery will start
Schedule	setType(ScheduleType type) Set the schedule type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Schedule

public Schedule()

Method Detail

getType

public ScheduleType getType()

Get the schedule type

Returns:

type

setType

public Schedule setType(ScheduleType type)

Set the schedule type

Parameters:

type -

getStartAt

public Date getStartAt()

Get the date, time and time zone at which the first delivery will start

Returns:

startAt

setStartAt

public Schedule setStartAt(Date startAt)

Set the date, time and time zone at which the first delivery will start

Parameters:

startAt -

getEndAt

public Date getEndAt()

Get the date, time and time zone at which the delivery schedule will end

Returns:

endAt

setEndAt

public Schedule setEndAt(Date endAt)

Set the date, time and time zone at which the delivery schedule will end

Parameters:

endAt -

getDayOfMonth

public Integer getDayOfMonth()

Get the day within the month

Returns:

dayOfMonth

setDayOfMonth

public Schedule setDayOfMonth(Integer dayOfMonth)

Set the day within the month

Parameters:

dayOfMonth -

getDayOrdinal

public DayOrdinal getDayOrdinal()

Get the day ordinal

Returns:

dayOrdinal

setDayOrdinal

public Schedule setDayOrdinal(DayOrdinal dayOrdinal)

Set the day ordinal

Parameters:

dayOrdinal -

getDayDescriptors

public List<DayDescriptor> getDayDescriptors()

Get an array of day descriptors

Returns:

dayDescriptors

setDayDescriptors

public Schedule setDayDescriptors(List<DayDescriptor> dayDescriptors)

Set the array of day descriptors

Parameters:

dayDescriptors -

getRepeatEvery

public Integer getRepeatEvery()

Get the frequency on which the request will be delivered.

Returns:

repeatEvery

setRepeatEvery

public Schedule setRepeatEvery(Integer repeatEvery)

Set the frequency on which the request will be delivered.

Parameters:

repeatEvery -

getLastSentAt

public Date getLastSentAt()

Get the date and time for when the last request was sent.

Returns:

lastSentAt

setLastSentAt

public Schedule setLastSentAt(Date lastSentAt)

Set the date and time for when the last request was sent.

Parameters:

lastSentAt -

getNextSendAt

public Date getNextSendAt()

Get the date and time for when the next request is scheduled to send.

Returns:

nextSendAt

sentNextSendAt

public Schedule sentNextSendAt(Date nextSendAt)

Set the date and time for when the next request is schedule to send.

Parameters:

nextSendAt -