universum.studios.android.intent

Class CalendarIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<CalendarIntent>

universum.studios.android.intent.CalendarIntent

public class CalendarIntent
extends BaseIntent<CalendarIntent>

A BaseIntent builder implementation providing API for building and starting of intents targeting a calendar related applications.

Whether a started calendar intent should insert a new event or edit the existing one may be specified via type(int) and supplying one of TYPE_VIEW, TYPE_INSERT_EVENT, TYPE_EDIT_EVENT, TYPE_VIEW_EVENT.

Intent type

• TYPE_VIEW

  Use this type when you want to open only calendar at the current date for preview. If you want to open calendar at different date, you can specify your desired date via beginTime(long).

• TYPE_VIEW_EVENT

  Use this type when you want to open an existing calendar event for preview. This type requires an id of the desired event to be specified via eventId(long) otherwise calendar intent cannot be build properly and BaseIntent.build(Context) will return null.

• TYPE_EDIT_EVENT

  Use this type when you want to open an existing calendar event for editing. This type requires an id of the desired event like described for TYPE_VIEW_EVENT above.

• TYPE_INSERT_EVENT

  Use this type when you want to create a new calendar event. This type requires a begin time to be specified via beginTime(long) and an end time via endTime(long). Following data are relatively optional but for 'good' calendar event should be always set: title(CharSequence), description(CharSequence), location(CharSequence), availability(int).

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CalendarIntent.Availability Defines an annotation for determining set of allowed flags for availability(int) method.
static interface	CalendarIntent.Type Defines an annotation for determining set of allowed flags for type(int) method.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVAILABILITY_BUSY Flag to identify BUSY availability for the newly creating calendar event.
static int	AVAILABILITY_FREE Flag to identify FREE availability for the newly creating calendar event.
static int	AVAILABILITY_TENTATIVE Flag to identify TENTATIVE availability for the newly creating calendar event.
static int	TYPE_EDIT_EVENT Flag to identify CalendarIntent as intent to edit existing calendar event.
static int	TYPE_INSERT_EVENT Flag to identify CalendarIntent as intent to create new calendar event.
static int	TYPE_VIEW Flag to identify CalendarIntent as intent to open calendar.
static int	TYPE_VIEW_EVENT Flag to identify CalendarIntent as intent to view existing calendar event.

Constructor Summary

Constructors

Constructor and Description
CalendarIntent() Creates a new instance of CalendarIntent.

Method Summary

Modifier and Type	Method and Description
int	availability() Returns the availability flag for the new calendar event.
CalendarIntent	availability(int availability) Sets an availability flag for the calendar event to be newly created.
long	beginTime() Returns the begin time for the new calendar event.
CalendarIntent	beginTime(long beginTime) Sets a begin time for the calendar event to be newly created.
CharSequence	description() Returns the description for the new calendar event.
CalendarIntent	description(CharSequence description) Sets a description for the calendar event to be newly created.
long	endTime() Returns the end time for the new calendar event.
CalendarIntent	endTime(long endTime) Sets an end time for the calendar event to be newly created.
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
long	eventId() Returns the id of the event to edit or view within calendar.
CalendarIntent	eventId(long eventId) Sets an id of the calendar event to be edited or viewed.
CharSequence	location() Returns the location for the new calendar event.
CalendarIntent	location(CharSequence location) Sets a location for the calendar event to be newly created.
protected Intent	onBuild(Context context) Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
long	time() Returns the time determining where to open the calendar for view.
CalendarIntent	time(long time) Sets a time determining where to open the calendar for view.
CharSequence	title() Returns the title for the new calendar event.
CalendarIntent	title(CharSequence title) Sets a title for the calendar event to be newly created.
int	type() Returns the type of the intent that will be created by this intent builder.
CalendarIntent	type(int type) Sets a type determining whether to create, view or edit an event in the calendar.

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, build, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, onStartWith, startWith, transitions

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_VIEW

public static final int TYPE_VIEW

Flag to identify CalendarIntent as intent to open calendar. Can be passed only to type(int).

See Also:

Constant Field Values

TYPE_INSERT_EVENT

public static final int TYPE_INSERT_EVENT

Flag to identify CalendarIntent as intent to create new calendar event. Can be passed only to type(int).

See Also:

Constant Field Values

TYPE_EDIT_EVENT

public static final int TYPE_EDIT_EVENT

Flag to identify CalendarIntent as intent to edit existing calendar event. Can be passed only to type(int).

See Also:

Constant Field Values

TYPE_VIEW_EVENT

public static final int TYPE_VIEW_EVENT

Flag to identify CalendarIntent as intent to view existing calendar event. Can be passed only to type(int).

See Also:

Constant Field Values

AVAILABILITY_BUSY

public static final int AVAILABILITY_BUSY

Flag to identify BUSY availability for the newly creating calendar event. See CalendarContract.Events#AVAILABILITY_BUSY for additional info.

See Also:

Constant Field Values

AVAILABILITY_FREE

public static final int AVAILABILITY_FREE

Flag to identify FREE availability for the newly creating calendar event. See CalendarContract.Events#AVAILABILITY_FREE for additional info.

See Also:

Constant Field Values

AVAILABILITY_TENTATIVE

public static final int AVAILABILITY_TENTATIVE

Flag to identify TENTATIVE availability for the newly creating calendar event. See CalendarContract.Events#AVAILABILITY_TENTATIVE for additional info.

See Also:

Constant Field Values

Constructor Detail

CalendarIntent

public CalendarIntent()

Creates a new instance of CalendarIntent.

The begin time will be initially set to the current time and the end time to begin time + 1.

See Also:

beginTime(long), endTime(long)

Method Detail

type

public CalendarIntent type(int type)

Sets a type determining whether to create, view or edit an event in the calendar.

Default value: TYPE_VIEW

Parameters:

type - One of TYPE_VIEW, TYPE_INSERT_EVENT, TYPE_EDIT_EVENT, TYPE_VIEW_EVENT.

Returns:

This intent builder to allow methods chaining.

See Also:

type()

type

public int type()

Returns the type of the intent that will be created by this intent builder.

Returns:

One of TYPE_VIEW, TYPE_INSERT_EVENT, TYPE_EDIT_EVENT, TYPE_VIEW_EVENT.

See Also:

type(int)

eventId

public CalendarIntent eventId(long eventId)

Sets an id of the calendar event to be edited or viewed. This id is only used in case of intent type TYPE_EDIT_EVENT or TYPE_VIEW_EVENT.

Default value: -1

Parameters:

eventId - Id of the desired calendar event (to edit or view).

Returns:

This intent builder to allow methods chaining.

See Also:

eventId(), type(int)

eventId

public long eventId()

Returns the id of the event to edit or view within calendar.

Returns:

Event id.

See Also:

eventId(long)

time

public CalendarIntent time(long time)

Sets a time determining where to open the calendar for view. This time is only used in case of intent type TYPE_VIEW.

Default value: System.currentTimeMillis()

Parameters:

time - The desired time where to open the calendar.

Returns:

This intent builder to allow methods chaining.

See Also:

time()

time

public long time()

Returns the time determining where to open the calendar for view.

Returns:

Time for calendar in milliseconds.

See Also:

time(long)

beginTime

public CalendarIntent beginTime(long beginTime)

Sets a begin time for the calendar event to be newly created. This time is only used in case of intent type TYPE_INSERT_EVENT or TYPE_VIEW.

Default value: System.currentTimeMillis()

Parameters:

beginTime - The desired begin time for the new event in milliseconds.

Returns:

This intent builder to allow methods chaining.

See Also:

endTime(long), type(int), beginTime()

beginTime

public long beginTime()

Returns the begin time for the new calendar event.

Returns:

Begin time for calendar event in milliseconds.

See Also:

beginTime(long), endTime(long)

endTime

public CalendarIntent endTime(long endTime)

Sets an end time for the calendar event to be newly created. This time is only used in case of intent type TYPE_INSERT_EVENT.

Note, that the default end time is set to beginTime() +1.

Parameters:

endTime - The desired end time for the new event in milliseconds.

Returns:

This intent builder to allow methods chaining.

See Also:

beginTime(long), type(int), endTime()

endTime

public long endTime()

Returns the end time for the new calendar event.

Returns:

End time for calendar event in milliseconds.

See Also:

endTime(long), beginTime(long)

title

public CalendarIntent title(CharSequence title)

Sets a title for the calendar event to be newly created. This text is used only in case of intent type TYPE_INSERT_EVENT or TYPE_EDIT_EVENT.

Parameters:

title - The desired title text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

title()

title

public CharSequence title()

Returns the title for the new calendar event.

Returns:

Title text for calendar event.

See Also:

title(CharSequence)

description

public CalendarIntent description(CharSequence description)

Sets a description for the calendar event to be newly created. This text is only used in case of intent type TYPE_INSERT_EVENT.

Parameters:

description - The desired description text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

description()

description

public CharSequence description()

Returns the description for the new calendar event.

Returns:

Description text for calendar event.

See Also:

description(CharSequence)

location

public CalendarIntent location(CharSequence location)

Sets a location for the calendar event to be newly created. This text is only used in case of intent type TYPE_INSERT_EVENT.

Parameters:

location - The desired location text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

location()

location

public CharSequence location()

Returns the location for the new calendar event.

Returns:

Location text for calendar event.

See Also:

location(CharSequence)

availability

public CalendarIntent availability(int availability)

Sets an availability flag for the calendar event to be newly created. This flag is used only in case of intent type TYPE_INSERT_EVENT.

Default value: AVAILABILITY_BUSY

Parameters:

availability - One of AVAILABILITY_BUSY, AVAILABILITY_FREE or AVAILABILITY_TENTATIVE.

Returns:

This intent builder to allow methods chaining.

See Also:

availability()

availability

public int availability()

Returns the availability flag for the new calendar event.

Default value: AVAILABILITY_BUSY

Returns:

Availability flag. One of AVAILABILITY_BUSY, AVAILABILITY_FREE or AVAILABILITY_TENTATIVE.

See Also:

availability(int)

ensureCanBuildOrThrow

protected void ensureCanBuildOrThrow()

Description copied from class: BaseIntent

Called to ensure that this builder can build its Intent from its current data.

If there are some required data missing/not specified, an exception indicating such state should be thrown. The default exception may be created via BaseIntent.cannotBuildIntentException(String).

Overrides:

ensureCanBuildOrThrow in class BaseIntent<CalendarIntent>

onBuild

protected Intent onBuild(Context context)

Description copied from class: BaseIntent

Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.

Specified by:

onBuild in class BaseIntent<CalendarIntent>

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.