/**
 * CalendarEntrySource.bbj
 * @author ndecker
 *
 * <code>CalendarEntrySource</code> is a BBj Custom Class that defines entry feeds for the <code>BBjCalendarWidget</code>.
 * Entry feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google
 * calendar, a web service that provides entries in JSON format, etc.
 *
 * This file is part of the <code>BBjCalendarWidget</code> plugin.
 *
 * For the full copyright and license information, please see the LICENSE.txt files distributed with this source code in the appropriate lib directory.
 *
 * @see <a href = 'https://fullcalendar.io' target = '_blank'>FullCalendar</a> for further information on the underlying JavaScript-based calendar
 * @see <a href = 'https://fullcalendar.io/docs/eventSources' target = '_blank'>eventSources</a> for information on the FullCalendar eventSources
 * @see <a href = 'https://fullcalendar.io/docs/google-calendar' target = '_blank'>events from Google Calendar</a> for information integrating Google Calendars with the FullCalendar library
 * @see <a href = 'https://developers.google.com/calendar/quickstart/js' target = '_blank'>Google Calendar API</a> for information about creating a Google developer account and creating an API key
 * @see <a href = 'https://fullcalendar.io/docs/icalendar' target = '_blank'>events from an iCalendar feed</a> for information integrating iCalendars with the FullCalendar library
 * @see <a href = 'https://icalendar.org/' target = '_blank'>https://icalendar.org/</a> for information on the iCalendar specification
 *
 * @since BBj 21.00
*/
package BBjCalendarWidget;
import com.google.gson.Gson;
import com.google.gson.JsonParser;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
/**
 * <code>CalendarEntrySource</code> is a BBj Custom Class that defines entry feeds for the <code>BBjCalendarWidget</code> and
 * serves as a base class for more specific entry sources such as the <code>CalendarEntrySourceGoogle</code> and
 * <code>CalendarEntrySourceiCalendar</code> classes.
 * <p>
 * Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google
 * calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
 *
 * @see <a href = 'https://fullcalendar.io' target = '_blank'>FullCalendar</a> for further information on the underlying JavaScript-based calendar
 * @see <a href = 'https://fullcalendar.io/docs/eventSources' target = '_blank'>eventSources</a> for information on the FullCalendar eventSources
 * @see <a href = 'https://fullcalendar.io/docs/google-calendar' target = '_blank'>events from Google Calendar</a> for information integrating Google Calendars with the FullCalendar library
 * @see <a href = 'https://developers.google.com/calendar/quickstart/js' target = '_blank'>Google Calendar API</a> for information about creating a Google developer account and creating an API key
 * @see <a href = 'https://fullcalendar.io/docs/icalendar' target = '_blank'>events from an iCalendar feed</a> for information integrating iCalendars with the FullCalendar library
 * @see <a href = 'https://icalendar.org/' target = '_blank'>https://icalendar.org/</a> for information on the iCalendar specification
 *
 * @since BBj 21.00
*/
public interface CalendarEntrySource {
/**
 * Returns the source's unique ID that identifes the entry source for later use, such as with the <code>getEntrySourceById()</code> method.
 * <p>
 * Note that if you create a <code>CalendarEntrySource</code> with a constructor that doesn't take any parameters
 * then the ID will be set automatically. If you wish to specify the ID, you should use the constructor that
 * takes an ID as a parameter.
 *
 * @return BBjString The entry source's unique ID.
*/
public BBjString getId() { }
/**
 * Sets the source's URL parameter.
 *
 * @param BBjString url! A BBjString filled with the URL for the entry source.
*/
public void setUrl(BBjString url!) { }
/**
 * Returns the source's URL parameter.
 *
 * @return BBjString A BBjString filled with the URL for the entry source.
*/
public BBjString getUrl() { }
/**
 * Sets the source's entry background color.
 * <p>
 * Colors may be specified as any valid CSS color, so <code>"red"</code>, <code>"rgb(255, 0, 0)"</code>, <code>"#ff0000"</code>, <code>"#f00"</code>, <code>"hsl(0, 100%, 50%)"</code>, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
 *
 * @param BBjString backgroundColor! A string that contains the color for the entry's background.
*/
public void setBackgroundColor(BBjString backgroundColor!) { }
/**
 * Returns the source's entry background color.
 *
 * @return BBjString The entry's entry's background color.
*/
public BBjString getBackgroundColor() { }
/**
 * Sets the source's entry border color.
 * <p>
 * Colors may be specified as any valid CSS color, so <code>"red"</code>, <code>"rgb(255, 0, 0)"</code>, <code>"#ff0000"</code>, <code>"#f00"</code>, <code>"hsl(0, 100%, 50%)"</code>, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
 *
 * @param BBjString borderColor! A string that contains the color for the entry's border.
*/
public void setBorderColor(BBjString borderColor!) { }
/**
 * Returns the source's entry border color.
 *
 * @return BBjString The entry's border color.
*/
public BBjString getBorderColor() { }
/**
 * Sets the source's entry text color.
 *<p>
 * Colors may be specified as any valid CSS color, so <code>"red"</code>, <code>"rgb(255, 0, 0)"</code>, <code>"#ff0000"</code>, <code>"#f00"</code>, <code>"hsl(0, 100%, 50%)"</code>, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
 *
 * @param BBjString textColor! A string that contains the color for the entry's text.
*/
public void setTextColor(BBjString textColor!) { }
/**
 * Returns the source's entry text color.
 *
 * @return BBjString The entry's text color.
*/
public BBjString getTextColor() { }
/**
 * Sets the source's entry combined background and border color.
 * <p>
 * Colors may be specified as any valid CSS color, so <code>"red"</code>, <code>"rgb(255, 0, 0)"</code>, <code>"#ff0000"</code>, <code>"#f00"</code>, <code>"hsl(0, 100%, 50%)"</code>, and all the versions of those formats that include an alpha channel are valid ways of specifying the color red.
 *
 * @param BBjString color! A string that contains the color for the entry's background and border.
*/
public void setColor(BBjString color!) { }
/**
 * Returns the source's entry combined background and border color.
 *
 * @return BBjString The entry's combined background and border color.
*/
public BBjString getColor() { }
/**
 * Sets the source's entry class name string (or CSS style).
 *
 * @param BBjString className! A string that contains a class name string (or CSS style), such as <code>"myclass1"</code>, that determines the HTML class that's associated with the entry.
*/
public void setClassName(BBjString className!) { }
/**
 * Returns the source's entry class name string.
 *
 * @return BBjString The entry's a class name string.
*/
public BBjString getClassName() { }
/**
 * Sets whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0), where the default value is 1.
 *
 * @param BBjNumber enableOverlap A BBjNumber acting as a boolean that determines whether entries being dragged and resized are allowed to overlap one other (1) or not (0).
*/
public void setEnableOverlap(BBjNumber overlap!) { }
/**
 * Returns whether the source's entries being dragged and resized are allowed to overlap one other (1) or not (0).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether entries being dragged and resized are allowed to overlap one other (1) or not (0).
*/
public BBjNumber getEnableOverlap() { }
/**
 * Sets the source's extended information that can be used to further describe the source.
 *
 * @param BBjString description! A string that's used to further describe the source.
*/
public void setDescription(BBjString description!) { }
/**
 * Returns a source's extended information that can be used to further describe the source.
 *
 * @return BBjString The source's description.
*/
public BBjString getDescription() { }
/**
 * Sets a source's alternate rendering style. This overrides the calendar's master EntryDisplay option for this specific entry.
 * <p>
 * The display style may be one of the following constants:
 * <ul>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_AUTO' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_AUTO()</a></code> - (default) When in daygrid, renders the event as a solid rectangle if it is all-day or multi-day. If a timed event, will render it with a dot. When in other views, will render normally.</li>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_BLOCK' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_BLOCK()</a></code> - When in daygrid, renders the event as a solid rectangle. When in other views, will render normally.</li>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_LIST_ITEM' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_LIST_ITEM()</a></code> - When in daygrid, renders the event with a dot. When in other views, will render normally.</li>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_BACKGROUND' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_BACKGROUND()</a></code> - Highlights the background of the entry's container.</li>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND()</a></code> - Hightlights the spans of time not occupied by an entry, or the opposite of the background.</li>
 * <li><code><a href = 'CalendarAPI.html#CALENDAR_ENTRY_DISPLAY_NONE' target = '_blank'>CalendarAPI.CALENDAR_ENTRY_DISPLAY_NONE()</a></code> - Disables the rendering of the event.</li>
 * </ul>
 *
 * @param BBjString display! A constant that denotes the desired entry display style.
*/
public void setDisplay(BBjString display!) { }
/**
 * Returns the source's display style.
 *
 * @return BBjString The source's display style.
*/
public BBjString getDisplay() { }
/**
 * Sets the source's entry editable status that determines if the entry can be modified by the user. This overrides the calendar's master EnableEditable option for this specific entry.
 *
 * @param BBjNumber editable! A BBjNumber acting as a boolean that indicates whether the source's entries can be modified by the user, where 1 = editable and 0 = read-only.
*/
public void setEnableEditable(BBjNumber editable!) { }
/**
 * Returns the source's entry editable status that determines if the entry can be modified by the user.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the source's entry editable status, where 1 = editable and 0 = read-only.
*/
public BBjNumber getEnableEditable() { }
/**
 * Sets the source's entry start time editable status that determines if the source's entry start time can be modified by the user by dragging (resizing).
 *
 * @param BBjNumber startEditable! A BBjNumber acting as a boolean that indicates whether the source's entry starting time can be modified by the user, where 1 = editable and 0 = not editable.
*/
public void setEnableStartEditable(BBjNumber startEditable!) { }
/**
 * Returns the source's entry start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the sources entry starting time can be modified by the user, where 1 = editable and 0 = not editable.
*/
public BBjNumber getEnableStartEditable() { }
/**
 * Sets the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
 *
 * @param BBjNumber durationEditable! A BBjNumber acting as a boolean that indicates whether the source's entry duration can be modified by the user, where 1 = editable and 0 = not editable.
*/
public void setEnableDurationEditable(BBjNumber durationEditable!) { }
/**
 * Returns the source's entry duration editable status that determines if the source's entry duration can be modified by the user by dragging (resizing).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the source's entry duration can be modified by the user, where 1 = editable and 0 = not editable.
*/
public BBjNumber getEnableDurationEditable() { }
/**
 * Returns the options object as a JsonObject.
 *
 * @return JsonObject The <code>CalendarEntrySource</code> object as a JsonObject.
 * @see <a href = 'https://www.javadoc.io/doc/com.google.code.gson/gson/2.8.5/com/google/gson/JsonObject.html' target = '_blank'>JsonObject</a> for information about an object in JSON format.
*/
public JsonObject getAsJsonObject() { }
/**
 * Returns a stringified JsonObject representation of the <code>CalendarEntrySource</code> object.
 *
 * @return BBjString The <code>CalendarEntrySource</code> object in stringified JSON format.
*/
public BBjString getAsString() { }
/**
 * Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the <code>CalendarEntrySource</code> object.
 *
 * @return BBjString The <code>CalendarEntrySource</code> in formatted stringified JSON format.
*/
public BBjString getAsFormattedString() { }
}
/**
 * <code>CalendarEntrySource</code> is a BBj Interface that defines entry feeds for the <code>BBjCalendarWidget</code>
 * in the <code><a href = 'http://calendar.google.com/' target = '_blank'>Google Calendar</a></code> format.
 * <p>
 * Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google
 * calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
 *
 * @see <a href = 'https://fullcalendar.io/docs/eventSources' target = '_blank'>eventSources</a> for information on the FullCalendar eventSources
 * @see <a href = 'https://fullcalendar.io/docs/google-calendar' target = '_blank'>events from Google Calendar</a> for information integrating Google Calendars with the FullCalendar library
 * @see <a href = 'https://developers.google.com/calendar/quickstart/js' target = '_blank'>Google Calendar API</a> for information about creating a Google developer account and creating an API key
*/
public interface CalendarEntrySourceGoogle extends CalendarEntrySource {
/**
 * Returns the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".
 *
 * @return BBjString The entry source's Calendar ID.
*/
public BBjString getCalendarId() { }
/**
 * Sets the source's "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".
 *
 * @param BBjString calendarId! The "Calendar ID" string from the settings page for the specific public Google calendar, e.g. "abcd1234@group.calendar.google.com".
*/
public BBjString setCalendarId(BBjString calendarId!) { }
}
/**
 * <code>CalendarEntrySourceiCalendar</code> is a BBj Interface that defines entry feeds for the <code>BBjCalendarWidget</code>
 * in the <code><a href = 'https://icalendar.org/' target = '_blank'>iCalendar</a></code> format.
 * <p>
 * Entry source feeds are a way to add multiple calendar entries to the calendar at once from a source like a public Google
 * calendar, a web service that provides entries in JSON format, an iCalendar (ICS) file or document, etc.
 * <p>
 * Note that iCalendar feeds will be queried upon calendar load and will not be queried after. Unlike a JSON or Google feed,
 * the URL will not be queried when the user navigates forward or backward in time. However, calling the calendar's
 * <code><a href = 'BBjCalendarWidget.html#refetchEntrySource' target = '_blank'>refetchEntrySource()</a></code> or
 * <code><a href = 'BBjCalendarWidget.html#refetchAllEntrySources' target = '_blank'>refetchAllEntrySources()</a></code> or
 * methods will cause the source feed to be requeried.
 *
 * @see <a href = 'https://fullcalendar.io/docs/eventSources' target = '_blank'>eventSources</a> for information on the FullCalendar eventSources
 * @see <a href = 'https://fullcalendar.io/docs/icalendar' target = '_blank'>events from an iCalendar feed</a> for information integrating iCalendars with the FullCalendar library
 * @see <a href = 'https://icalendar.org/' target = '_blank'>https://icalendar.org/</a> for information on the iCalendar specification
*/
public interface CalendarEntrySourceiCalendar extends CalendarEntrySource {
}