com.inrix.sdk.model

Class Schedule.ScheduleOptions

java.lang.Object

com.inrix.sdk.model.Schedule.ScheduleOptions

Direct Known Subclasses:

Schedule.OneTimeScheduleOptions, Schedule.RecurringScheduleOptions

Enclosing class:

Schedule

public abstract static class Schedule.ScheduleOptions
extends Object

Represents the options for a Schedule.

See Also:

Schedule.OneTimeScheduleOptions, Schedule.RecurringScheduleOptions

Method Summary

Methods

Modifier and Type	Method and Description
Date	getDateTime() Get the schedule date and time.
Schedule.ScheduleType	getScheduleType() Get the type of schedule.
boolean	isRecurring() Indicates whether this ScheduleOptions is a recurring schedule or not.
void	setDateTime(Date dateTime) Set the schedule date and time.
void	setScheduleType(Schedule.ScheduleType scheduleType) Set the type of schedule.

Methods inherited from class java.lang.Object

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

Method Detail

getScheduleType

public Schedule.ScheduleType getScheduleType()

Get the type of schedule.

Returns:

Type of schedule.

See Also:

Schedule.ScheduleType

setScheduleType

public void setScheduleType(@NonNull
                   Schedule.ScheduleType scheduleType)

Set the type of schedule. Note that this will change the interpretation of the specified date and time, which may also need to be updated.

Parameters:

scheduleType - Type of schedule, must not be null.

See Also:

Schedule.ScheduleType

getDateTime

public Date getDateTime()

Get the schedule date and time. Interpretation of this value depends on the specified Schedule.ScheduleType.

The date and time is always the local time at the origin or destination (depending on whether the schedule type is ARRIVAL or DEPARTURE. The Date object should have the timezone set to "UTC" to prevent issues while handling this value.

Returns:

Schedule date and time.

See Also:

Schedule.ScheduleType

setDateTime

public void setDateTime(@NonNull
               Date dateTime)

Set the schedule date and time. Interpretation of this value depends on the specified Schedule.ScheduleType.

The date and time is always the local time at the origin or destination (depending on whether the schedule type is ARRIVAL or DEPARTURE. The Date object should have the timezone set to "UTC" to prevent issues while handling this value.

Parameters:

dateTime - Schedule date and time, must not be null.

See Also:

Schedule.ScheduleType

isRecurring

public boolean isRecurring()

Indicates whether this ScheduleOptions is a recurring schedule or not.

Returns:

true if the schedule is recurring, false otherwise