/**
 * CalendarEntry.bbj
 * @author ndecker
 *
 * The <code>CalendarEntry</code> is a BBj Interface that defines a calendar entry, i.e. an appointment or event, for the <code>BBjCalendarWidget</code>.
 * 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/event-object' target = '_blank'>FullCalendar Event Object</a> for further information
 * @see <a href = 'https://fullcalendar.io/docs/event-model' target = '_blank'>FullCalendar Event Object</a> for further information
 *
 * @since BBj 21.00
*/
package BBjCalendarWidget;
import java.util.HashMap;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
/**
 * <code>CalendarEntry</code> is a BBj Interface that contains information for a <a href = 'BBjCalendarWidget.html' target = '_blank'>BBjCalendarWidget's</a> entry (event, appointment, etc.).
 *
 * <b>Note</b>: The values for date/time parameters should be in ISO 8601 format as in:
 * <ul>
 * <li><code>YYYY-MM-DD</code>, e.g. "1997-07-16" for dates.</li>
 * <li><code>YYYY-MM-DDThh:mm:ss</code>, e.g. "1997-07-16T19:20:00" for dates and times.</li>
 * <li><code>YYYY-MM-DDThh:mm:ssZ</code>, e.g. "1997-07-16T19:20:00-06:00" for dates and times with timezone information.</li>
 * </ul>
 *
 * <b>Note</b>: All ending date/time parameters are exclusive. For example, an event with the end of 2018-09-03 will appear to span through 2018-09-02 but end before the start of 2018-09-03.
 *
 * @see <a href = 'https://www.w3.org/TR/NOTE-datetime' target = '_blank'>Date and Time Formats</a> for information on ISO 8601 date/time formats.
 *
 * @since BBj 21.00
*/
public interface CalendarEntry {
/**
 * <p>
 * When in daygrid view, it renders the entry as a solid rectangle if it is all-day or multi-day.
 * If it's a timed entry, it renders the entry as a colored a dot. When in other views, the entry will render normally.
 * @return A BBjString with the 'auto' display style which is the default.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_AUTO() { }
/**
 * <p>
 * When in daygrid view, it renders the entry as a solid rectangle.
 * When in other views, the entry will render normally.
 * @return A BBjString with the 'auto' display style which is the default.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_BLOCK() { }
/**
 * <p>
 * When in daygrid view, it renders the entry as a colored dot.
 * When in other views, the entry will render normally.
 * @return A BBjString with the 'auto' display style which is the default.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_LIST_ITEM() { }
/**
 * <p>
 * This modifies the background of the entry's date/time frame in the calendar.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_BACKGROUND() { }
/**
 * <p>
 * This inversely modifies the background of the entry's date/time frame in the calendar.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_INVERSE_BACKGROUND() { }
/**
 * <p>
 * This hides the entry on the calendar.
*/
public static BBjString CALENDAR_ENTRY_DISPLAY_NONE() { }
/**
 * Sets an entry's optional unique ID that can be used later to identify the entry. If the entry's ID is not provided, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
 *
 * @param BBjString id! A string to uniquely identify the entry.
*/
public void setId(BBjString id!) { }
/**
 * Returns an entry's unique ID if it has previously been set. If the entry's ID was set at creation time, it will be set to the same value as the UUID, which is guaranteed to be set automatically.
 *
 * @return BBjString The entry's ID, or null() if it has not been previously been set.
*/
public BBjString getId() { }
/**
 * Returns an entry's unique UUID that is automatically generated for all entries.
 *
 * @return BBjString The entry's automatically generated UUID.
*/
public BBjString getUuid() { }
/**
 * Sets entry's title that is the description/summary text that will appear on an entry.
 *
 * @param BBjString title! A string to be used as the entry's title.
*/
public void setTitle(BBjString title!) { }
/**
 * Returns an entry's optional unique ID if it has previously been set.
 *
 * @return BBjString The entry's title.
*/
public BBjString getTitle() { }
/**
 * Sets an entry's extended information that can be used to further describe the entry beyond the title text.
 * Note that the description property is not one of the standard FullCalendar fields. The BBjCalendarWidget
 * will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods
 * in order to work with this property.
 *
 * @param BBjString description! A string that's used to further describe the entry beyond the title text.
 * @see <a href = 'https://fullcalendar.io/docs/event-object' target = '_blank'>FullCalendar Event Object</a> for information about non-standard fields.
*/
public void setDescription(BBjString description!) { }
/**
 * Returns an entry's extended information that can be used to further describe the entry beyond the title text.
 *
 * @return BBjString The entry's description.
*/
public BBjString getDescription() { }
/**
 * Sets an entry's location that can be used to define a location for the entry.
 * Note that the location property is not one of the standard FullCalendar fields. The BBjCalendarWidget
 * will manage this field automatically so that you don't need to use the set/getExtendedProperties() methods
 * in order to work with this property.
 *
 * @param BBjString location! A string that's used to define a location for the entry.
 * @see <a href = 'https://fullcalendar.io/docs/event-object' target = '_blank'>FullCalendar Event Object</a> for information about non-standard fields.
*/
public void setLocation(BBjString location!) { }
/**
 * Returns an entry's extended information that can be used to further describe the entry beyond the title text.
 *
 * @return BBjString The entry's location.
*/
public BBjString getLocation() { }
/**
 * Sets an entry's associated URL that may be visited when this entry is clicked by the user.
 *
 * @param BBjString url! A string that contains a URL to be associated with the entry.
*/
public void setUrl(BBjString url!) { }
/**
 * Returns an entry's associated URL that may be visited when this entry is clicked by the user.
 *
 * @return BBjString The entry's URL.
*/
public BBjString getUrl() { }
/**
 * Sets an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
 *
 * @param BBjString groupId! A string that contains the entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
*/
public void setGroupId(BBjString groupId!) { }
/**
 * Returns an entry's group ID. Entries that share a groupId will be dragged and resized together automatically.
 *
 * @return BBjString The entry's group ID.
*/
public BBjString getGroupId() { }
/**
 * Sets an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
 *
 * @param BBjNumber allDay! A BBjNumber acting as a boolean that determines if the entry lasts all day (1) or not (0).
*/
public void setAllDay(BBjNumber allDay!) { }
/**
 * Returns an entry's all-day status that determines if the entry is shown in the "all-day" section of the view, if applicable.
 *
 * @return BBjNumber The entry's all-day status where 1 = all-day and 0 = a timed entry.
*/
public BBjNumber getAllDay() { }
/**
 * Sets an entry's overlap status that determines if the entries may be dragged/resized over one another.
 *
 * @param BBjNumber overlap! A BBjNumber acting as a boolean that determines if entries can overlap one another (1) or not (0).
*/
public void setEnableEntryOverlap(BBjNumber overlap!) { }
/**
 * Returns an entry's overlap status that determines if the entries may be dragged/resized over one another.
 *
 * @return BBjNumber The entry's overlap status where 1 = entries may overlap and 0 = entries cannot overlap.
*/
public BBjNumber getEnableEntryOverlap() { }
/**
 * Sets an entry's starting date/time. If the entry is explicitly all-day, then the time portion will be ignored.
 *
 * @param BBjString start! A string that contains the starting date/time for the entry.
*/
public void setStart(BBjString start!) { }
/**
 * Returns an entry's starting date/time.
 *
 * @return BBjString The entry's starting date/time.
*/
public BBjString getStart() { }
/**
 * Sets an entry's exclusive ending date/time. If the entry is explicitly all-day, then the time portion will be ignored.
 *
 * @param BBjString end! A string that contains the ending date/time for the entry.
*/
public void setEnd(BBjString end!) { }
/**
 * Returns an entry's exclusive ending date/time.
 *
 * @return BBjString The entry's ending date/time.
*/
public BBjString getEnd() { }
/**
 * Sets an entry's 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 an entry's background color.
 *
 * @return BBjString The entry's entry's background color.
*/
public BBjString getBackgroundColor() { }
/**
 * Sets an entry's 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 an entry's border color.
 *
 * @return BBjString The entry's border color.
*/
public BBjString getBorderColor() { }
/**
 * Sets an entry's 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 an entry's text color.
 *
 * @return BBjString The entry's text color.
*/
public BBjString getTextColor() { }
/**
 * Sets an entry's combined background and border color.
 * <b>Note</b>: For a quick way to set a <code>CalendarEvent</code>'s colors, see the <code><a href = '#setColors'>setColors(backgroundColor!, borderColor!, textColor!)</a></code> method.
 * <p>
 * <b>Note</b>: This is a shorthand way of specifying the backgroundColor and borderColor at the same time. The color will be passed
 * to the FullCalendar, but it internally sets the <code>backgroundColor</code> and <code>borderColor</code> to the value of the
 * specified color and discards the given color. Therefore, you can set colors with this method, but the corresponding <code>getColor()</code>
 * method may not return anything if you're working with a <code>CalendarEvent</code> object that was returned from the FullCalendar.
 * <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 an entry's combined background and border color, or null if the <code>CalendarEvent</code> object was provided
 * by the FullCalendar. This is because the <code>setColor()</code> method is a shorthand way of specifying the
 * backgroundColor and borderColor at the same time. The color will be passed to the FullCalendar, but it internally sets
 * the <code>backgroundColor</code> and <code>borderColor</code> to the value of the specified color and discards the given
 * color. Therefore, you can set colors with the <code>setColor()</code> method, but this <code>getColor()</code>
 * method may not return anything if you're working with a <code>CalendarEvent</code> object that was returned from the FullCalendar.
 * <p>
 * <b>Note</b>: For a quick way to set a <code>CalendarEvent</code>'s colors, see the <code><a href = '#setColors'>setColors(backgroundColor!, borderColor!, textColor!)</a></code> method.
 * @return BBjString The entry's combined background and border color.
*/
public BBjString getColor() { }
/**
 * A convenience method that sets an entry's background, border, and text colors in a single method call.
 * <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 setColors(BBjString backgroundColor!, BBjString borderColor!, BBjString textColor!) { }
/**
 * <b>DEPRECATED</b> Sets an entry's class name string (or CSS style) such as <code>"myclass1"</code>, that determines the HTML class that's associated with the entry.
 * <p>
 * See the <code>setClassNames()</code> methods to set multiple class names.
 *
 * @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.
 * @deprecated Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the either the <code><a href = '#setClassNames'>setClassNames(BBjVector)</a></code> or <code><a href = '#setClassNames'>setClassNames(BBjString)</a></code> method instead.
*/
public void setClassName(BBjString className!) { }
/**
 * <b>DEPRECATED</b> Returns an entry's a class name string.
 *
 * @return BBjString The entry's a class name string.
 * @deprecated Deprecated in BBj 21.12 because this only supports a single class name and the class has methods that support mutliple class names. Please use the <code><a href = '#getClassNames'>getClassNames()</a></code> method instead.
*/
public BBjString getClassName() { }
/**
 * Sets an entry's class names (or CSS styles) from a BBjVector that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be <code>work</code> or <code>personal</code>.
 * <p>
 * Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the <code><a href = '#addClassName'>addClassName()</a></code> method.
 * To remove a single class name from the entry, you can call the <code><a href = '#removeClassName'>removeClassName()</a></code> method, or get all the class names in a vector, remove the undesired classes, then set the class names.
 * <p>
 * Here's an example of how you can use custom class names and the BBjCalendarWidget's <code><a href = 'BBjCalendarWidget.html#injectCss' target = '_blank'>injectCSS()</a></code> method to affect a calendar entry's display:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.addClassName("small-text")
 * myCal!.addEntry(myEntry!)
 *
 * <i><span style = 'color:#080;'>rem Inject custom CSS to change the event's text size</span></i>
 * myCal!.injectCss(" .small-text div { font-size: 7px; } ")
 * </div></code></pre></blockquote>
 *
 * @param BBjVector classNames! A vector of strings with the entry's class names (or CSS styles) such as <code>"myclass1"</code>, that determines the HTML class that's associated with the entry.
*/
public void setClassNames(BBjVector classNames!) { }
/**
 * Sets an entry's class names (or CSS styles) from a comma-delimited string that determine the HTML class that's associated with the entry. Class names should NOT be preceeded by a period, so possible class names could be <code>work</code> or <code>personal</code>.
 * <p>
 * This is similar to the <code>setClassNames()</code> method that takes a BBjVector except that it takes a comma-delimted string of class names for succinctness.
 * <p>
 * Note that this sets all the class names at once. It's possible to add class names, regardless of whether they have been set or not, using the <code><a href = '#addClassName'>addClassName()</a></code> method.
 * To remove a single class name from the entry, you can call the <code><a href = '#removeClassName'>removeClassName()</a></code> method, or get all the class names in a vector, remove the undesired classes, then set the class names.
 * <p>
 * Here's an example of how you can use custom class names and the BBjCalendarWidget's <code><a href = 'BBjCalendarWidget.html#injectCss' target = '_blank'>injectCSS()</a></code> method to affect a calendar entry's display:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.addClassName("small-text")
 * myCal!.addEntry(myEntry!)
 *
 * <i><span style = 'color:#080;'>rem Inject custom CSS to change the event's text size</span></i>
 * myCal!.injectCss(" .small-text div { font-size: 7px; } ")
 * </div></code></pre></blockquote>
 *
 * @param BBjString classNames! A comma-delimted string of class names such as <code>"work, personal"</code>.
 * @since BBj 21.12
*/
public void setClassNames(BBjString classNames!) { }
/**
 * Returns an entry's class names (or CSS styles) in a vector of strings.
 *
 * @return BBjString The entry's class names in a vector of strings.
*/
public BBjVector getClassNames() { }
/**
 * Adds the provided class name string (or CSS style) such as <code>"myclass1"</code> to the entry's vector of class names.
 * <p>
 * This method can be used in place of the <code><a href = '#setClassNames'>setClassNames()</a></code> method as it adds the provided class name to the entry's vector of
 * class names. It may be easier to call this method if you only need to set a few tags, as the <code><a href = '#setClassNames'>setClassNames()</a></code> method requires
 * you to create and populate a BBjVector (unless you use the version that takes a comma-delimited string).
 * <p>
 * Here's an example of how you can use custom class names and the BBjCalendarWidget's <code><a href = 'BBjCalendarWidget.html#injectCss' target = '_blank'>injectCSS()</a></code> method to affect a calendar entry's display:
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Create a calendar entry for 3PM today and give it a custom CSS class name of "small-text", then add it to the calendar</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.addClassName("small-text")
 * myCal!.addEntry(myEntry!)
 *
 * <i><span style = 'color:#080;'>rem Inject custom CSS to change the event's text size</span></i>
 * myCal!.injectCss(" .small-text div { font-size: 7px; } ")
 * </div></code></pre></blockquote>
 *
 * @param BBjString className! The class name (or CSS style) such as <code>"myclass1"</code> to add to the entry.
 * @since BBj 21.12
*/
public void addClassName(BBjString className!) { }
/**
 * Removes the provided class name string (or CSS style) from the entry's vector of class names.
 *
 * @param BBjString className! The class name (or CSS style) to remove from the entry's vector of class names.
 * @since BBj 21.12
*/
public void removeClassName(BBjString className!) { }
/**
 * Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
 *
 * @param BBjVector tags! A vector of strings with the entry's tags.
*/
public void setTags(BBjVector tags!) { }
/**
 * Sets an entry's tags that can be used for a variety of purposes such as hiding or showing entries based on given tags.
 * <p>
 * This is similar to the <code>setTags()</code> method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
 *
 * @param BBjString tags! A comma-delimted string of tags such as "work, programming".
*/
public void setTags(BBjString tags!) { }
/**
 * Returns an entry's tags in a vector of strings.
 *
 * @return BBjVector The entry's tags in a vector of strings.
*/
public BBjVector getTags() { }
/**
 * Adds the provided tag to the entry's vector of tags.
 * <p>
 * This method can be used in place of the <code>setTags()</code> method as it adds the provided tag to the entry's vector of tags. It may
 * be easier to call this method if you only need to set a few tags, as the <code>setTags()</code> method requires you to create and
 * populate a BBjVector or a comma-delimited string.
 *
 * @param BBjString tag! The tag to add to the entry.
*/
public void addTag(BBjString tag!) { }
/**
 * Removes the provided tag from the entry's vector of tags.
 *
 * @param BBjString tag! The tag to remove from the entry's vector of tags.
*/
public void removeTag(BBjString tag!) { }
/**
 * Returns whether the provided tag exists the entry's vector of tags.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains the provided tag (1) or not (0).
*/
public BBjNumber containsTag(BBjString tag!) { }
/**
 * Returns whether an entry contains any of the provided tags in the entry's vector of tags.
 *
 * @param BBjVector tags! A BBjVector filled with the tags of interest.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains any of the supplied tags (1) or not (0).
*/
public BBjNumber containsAnyTag(BBjVector tags!) { }
/**
 * Returns whether an entry contains any of the provided tags in the entry's vector of tags.
 * <p>
 * This is similar to the <code>containsAnyTag()</code> method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
 *
 * @param BBjString tags! A comma-delimted string of tags such as "work, programming, meeting".
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains any of the supplied tags (1) or not (0).
*/
public BBjNumber containsAnyTag(BBjString tags!) { }
/**
 * Returns whether an entry contains all the provided tags in the entry's vector of tags.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains all the supplied tags (1) or not (0).
*/
public BBjNumber containsAllTags(BBjVector tags!) { }
/**
 * Returns whether a <code>CalendarEntry</code> contains all the provided tags in comma-delimted string in the entry's vector of tags.
 * <p>
 * This is similar to the <code>containsAllTags()</code> method that takes a BBjVector except that it takes a comma-delimted string of tags for succinctness.
 *
 * @param BBjString tags! A comma-delimted string of tags such as "work, programming, meeting".
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains all the supplied tags (1) or not (0).
*/
public BBjNumber containsAllTags(BBjString tags!) { }
/**
 * Adds the provided extended property to the entry's HashMap of extended properties given the property key and value.
 * <p>
 * Note that this method simply puts the provide key/value pair in the extended properties HashMap. If an entry in the HashMap
 * already existed with that particular key, then it will be updated with the provided value.
 * <p>
 * This method can be used in place of the <code>setExtendedProperties()</code> method as it adds the provided property to the entry's HashMap of extended properties. It may
 * be easier to call this method if you only need to set a few extended properties, as the <code>setExtendedProperties()</code> method requires you to create and
 * populate a HashMap.
 *
 * @param BBjString key! The key of the extended property to add to the entry.
 * @param BBjString value! The value of the extended property to add to the entry.
 * @since BBj 21.12
*/
public void addExtendedProperty(BBjString key!, BBjString value!) { }
/**
 * Removes the extended property from the entry's HashMap of extended properties given the property key.
 *
 * @param BBjString key! The extended property key to remove from the entry's HashMap of extended properties.
 * @since BBj 21.12
*/
public void removeExtendedProperty(BBjString key!) { }
/**
 * Returns whether the provided extended property key exists the entry's HashMap of extended properties.
 *
 * @param BBjString key! The key that you're checking to see if it exists in the entry's extended properties.
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry contains the provided extended property key (1) or not (0).
 * @since BBj 21.12
*/
public BBjNumber containsExtendedPropertyKey(BBjString key!) { }
/**
 * Returns the value of the provided extended property if the key exists in the entry's HashMap of extended properties.
 *
 * @param BBjString key! The extended property key that you wish to get the associated value
 *
 * @return BBjString The value of the extended property key. If the provided key does not exist in the entry's extended properties, this method will return null().
 * @since BBj 21.12
*/
public BBjString getExtendedPropertyValue(BBjString key!) { }
/**
 * Sets an entry's extended properties, i.e. custom properties.
 *
 * @param HashMap extendedProperties! A HashMap of custom key/value string pairs that define the entry's custom properties.
*/
public void setExtendedProperties(HashMap extendedProperties!) { }
/**
 * Returns an entry's custom key/value string pairs that define the entry's custom properties
 *
 * @return HashMap The entry's custom key/value string pairs that define the entry's custom properties.
*/
public HashMap getExtendedProperties() { }
/**
 * Sets an entry'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#CCALENDAR_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> - Won't render the event at all.</li>
 * </ul>
 *
 * @param BBjString display! A constant that denotes the desired entry display style.
*/
public void setDisplay(BBjString display!) { }
/**
 * Returns an entry's display style.
 *
 * @return BBjString The entry's display style.
*/
public BBjString getDisplay() { }
/**
 * Sets an entry's editable status that determines if the user can modify the entry, i.e. change the entry's starting date/time and duration.
 * This overrides the calendar's master EnableEditable option for this specific entry.
 * <b>Note</b>: This determines if the events can be dragged and resized and enables or disables both settings simultaneously. IOW, it's a shorhand way of setting both
 * the EnableStartEditable and EnableDurationEditable properties at the same time. If you don’t want to set both, use the more specific
 * <code><a href = '#setEnableStartEditable'>setEnableStartEditable()</a></code> or <code><a href = '#setEnableDurationEditable'>setEnableDurationEditable()</a></code> methods instead.
 *
 * <blockquote><pre><code><div style = 'background:#E1E6EA; border:1px solid #000; border-radius:1em; padding:0 1em;'>
 *
 * <i><span style = 'color:#080;'>rem Example 1: The user can move and resize the entry, i.e. change the starting time/date and the duration</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.setEnableEditable(1)
 *
 * <i><span style = 'color:#080;'>rem Example 2: The user can move and resize the entry, i.e. change the starting time/date and the duration</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.setEnableStartEditable(1)
 * myEntry!.setEnableDurationEditable(1)
 *
 * <i><span style = 'color:#080;'>rem Example 3: The user can change the entry's starting time/date but not the duration</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.setEnableStartEditable(1)
 *
 * <i><span style = 'color:#080;'>rem Example 4: The user can change the entry's duration but not the starting time/date</span></i>
 * myEntry! = CalendarAPI.createCalendarEntry("Write Advantage Article", date(0, "%Yl-%Mz-%Dz") + "T15:00:00")
 * myEntry!.setEnableDurationEditable(1)
 * </div></code></pre></blockquote>
 *
 * @param BBjNumber editable! A BBjNumber acting as a boolean that indicates whether the entry can be modified by the user, where 1 = editable and 0 = read-only.
*/
public void setEnableEditable(BBjNumber editable!) { }
/**
 * Returns the entry's 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 entry's editable status, where 1 = editable and 0 = read-only.
*/
public BBjNumber getEnableEditable() { }
/**
 * Sets an entry's start time editable status that determines if the entry's start time can be modified by the user by dragging (resizing). This overrides the calendar's master EnableStartEditable option for this specific entry.
 * <p>
 * <b>Note</b>: See the <code><a href = '#setEnableEditable'>setEnableEditable()</a></code> method if you wish to set the
 * <code><a href = '#setEnableStartEditable'>setEnableStartEditable()</a></code> and <code><a href = '#setEnableDurationEditable'>setEnableDurationEditable()</a></code>
 * parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
 *
 * @param BBjNumber startEditable! A BBjNumber acting as a boolean that indicates whether the entry's starting time can be modified by the user, where 1 = editable and 0 = not editable.
*/
public void setEnableStartEditable(BBjNumber startEditable!) { }
/**
 * Returns the entry's 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 entry's starting time can be modified by the user, where 1 = editable and 0 = not editable.
*/
public BBjNumber getEnableStartEditable() { }
/**
 * Sets an entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing). This overrides the calendar's master EnableDurationEditable option for this specific entry.
 * <p>
 * <b>Note</b>: See the <code><a href = '#setEnableEditable'>setEnableEditable()</a></code> method if you wish to set the
 * <code><a href = '#setEnableStartEditable'>setEnableStartEditable()</a></code> and <code><a href = '#setEnableDurationEditable'>setEnableDurationEditable()</a></code>
 * parameters simultaneously. That method also contains sample code that demonstrates different ways to affect an entry's editability.
 *
 * @param BBjNumber durationEditable! A BBjNumber acting as a boolean that indicates whether the entry's duration can be modified by the user, where 1 = editable and 0 = not editable.
*/
public void setEnableDurationEditable(BBjNumber durationEditable!) { }
/**
 * Returns the entry's duration editable status that determines if the entry's duration can be modified by the user by dragging (resizing).
 *
 * @return BBjNumber A BBjNumber acting as a boolean that indicates whether the entry's duration can be modified by the user, where 1 = editable and 0 = not editable.
*/
public BBjNumber getEnableDurationEditable() { }
/**
 * Returns a stringified JsonObject representation of the <code>CalendarEntry</code> object.
 *
 * @return BBjString The calendar entry in stringified JSON format.
*/
public BBjString getAsString() { }
/**
 * Returns a formatted, i.e. pretty-printed or beautified, stringified JsonObject representation of the <code>CalendarEntry</code> object.
 *
 * @return BBjString The calendar entry in stringified JSON format.
*/
public BBjString getAsFormattedString() { }
/**
 * Returns a JsonObject representation of the <code>CalendarEntry</code> object.
 *
 * @return JsonObject The calendar entry 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() { }
}