com.inrix.sdk.model

Class Schedule

java.lang.Object

com.inrix.sdk.model.Schedule

All Implemented Interfaces:

Parcelable, Cloneable

public class Schedule
extends Object
implements Parcelable, Cloneable

Represents the schedule for a SavedTrip or SavedLocation. The schedule defines essential aspects of scheduling the SavedTrip or SavedLocation including what the arrival/departure time should be, whether (and when) to notify the user and any recurrence details.

A Schedule can be created with one of two options:

• Schedule.OneTimeScheduleOptions: For a one time scheduling which does not repeat.
• Schedule.RecurringScheduleOptions: For a recurring schedules which repeats based on a user defined cadence.

Example: One time schedule

 // Notify the user about this trip 10 minutes before departure time
 NotificationOptions notificationOptions = new NotificationOptions(true, 10);

 // Timezone is set to UTC regardless of what timezone the user is currently in or the origin is in
 DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
 format.setTimeZone(TimeZone.getTimeZone("UTC"));

 // Set the departure time to February 15, 2015 at 17:33:23 (at the origin)
 Date dateTime = format.parse("2015-02-15T17:33:23");

 OneTimeScheduleOptions scheduleOptions = new OneTimeScheduleOptions(ScheduleType.DEPARTURE, dateTime);

 Schedule schedule = new Schedule(scheduleOptions, notificationOptions);

Example: Recurring schedule every Saturday and Sunday

 // Do not notify the user
 NotificationOptions notificationOptions = null;

 // Timezone is set to UTC regardless of what timezone the user is currently in or the origin is in
 DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
 format.setTimeZone(TimeZone.getTimeZone("UTC"));

 // Set the departure time of the first occurrence to February 15, 2015 at 17:33:23 (at the origin)
 Date dateTime = format.parse("2015-02-15T17:33:23");

 RecurringScheduleOptions scheduleOptions = new RecurringScheduleOptions(ScheduleType.DEPARTURE, dateTime, Arrays.asList(Calendar.SATURDAY, Calendar.SUNDAY));

 Schedule schedule = new Schedule(scheduleOptions, notificationOptions);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schedule.NotificationOptions Represents the options for notifications for a schedule.
static class	Schedule.OneTimeScheduleOptions Represents the options for a one time schedule.
static class	Schedule.RecurringScheduleOptions Represents the options for a recurring schedule.
static class	Schedule.ScheduleOptions Represents the options for a Schedule.
static class	Schedule.ScheduleType ScheduleType determines whether it should be scheduled with a specified arrival time (taking into consideration traffic and stops) or a specified departure time.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Schedule>	CREATOR Parcelable creator for this type.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Schedule(Schedule.ScheduleOptions scheduleOptions, Schedule.NotificationOptions notificationOptions) Create a Schedule with the specified Schedule.ScheduleOptions and Schedule.NotificationOptions.

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Schedule.NotificationOptions	getNotificationOptions() Get the notification options associated with this Schedule.
Schedule.ScheduleOptions	getScheduleOptions() Get the schedule options associated with this Schedule.
int	hashCode()
void	setNotificationOptions(Schedule.NotificationOptions notificationOptions) Set the notification options associated with this Schedule.
void	setScheduleOptions(Schedule.ScheduleOptions scheduleOptions) Set the schedule options associated with this Schedule.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<Schedule> CREATOR

Parcelable creator for this type.

Constructor Detail

Schedule

public Schedule(@NonNull
        Schedule.ScheduleOptions scheduleOptions,
        @Nullable
        Schedule.NotificationOptions notificationOptions)

Create a Schedule with the specified Schedule.ScheduleOptions and Schedule.NotificationOptions.

Parameters:

scheduleOptions - Schedule options such as date, time and recurrence.

notificationOptions - Notification options such as notification time.

See Also:

Schedule.OneTimeScheduleOptions, Schedule.RecurringScheduleOptions, Schedule.NotificationOptions

Method Detail

describeContents

public final int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public final void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

getNotificationOptions

public Schedule.NotificationOptions getNotificationOptions()

Get the notification options associated with this Schedule.

Returns:

Notification options.

See Also:

Schedule.NotificationOptions

setNotificationOptions

public void setNotificationOptions(@Nullable
                          Schedule.NotificationOptions notificationOptions)

Set the notification options associated with this Schedule.

Parameters:

notificationOptions - Notification options, may be null.

See Also:

Schedule.NotificationOptions

getScheduleOptions

public Schedule.ScheduleOptions getScheduleOptions()

Get the schedule options associated with this Schedule. Caller should check the value of Schedule.ScheduleOptions.isRecurring() to determine whether the returned object is an instance of Schedule.OneTimeScheduleOptions or Schedule.RecurringScheduleOptions.

Returns:

schedule options

See Also:

Schedule.OneTimeScheduleOptions, Schedule.RecurringScheduleOptions

setScheduleOptions

public void setScheduleOptions(@NonNull
                      Schedule.ScheduleOptions scheduleOptions)

Set the schedule options associated with this Schedule.

Parameters:

scheduleOptions - Schedule options.

See Also:

Schedule.OneTimeScheduleOptions, Schedule.RecurringScheduleOptions

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object