com.jalios.jcms.calendar

Interface CalendarEventInterface

All Known Implementing Classes:

AbstractCalendarEvent

public interface CalendarEventInterface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CalendarEventInterface.IconSize Enum of supported icon sizes.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.TreeSet<Member>	getAllAttendingMembersSet() Return a set containing all the members attending this event.
java.util.TreeSet<Member>	getAllAttendingMembersSet(boolean checkReadRight) Return a set containing all the members attending this event checking for readright or not.
Group[]	getAttendingGroups()
Member[]	getAttendingMembers()
java.util.TreeSet<Member>	getAttendingMemberSet() Retrieve the attending members as a Set, with the author included.
boolean	getAuthorAttendee()
java.lang.String	getDataIconHtml() Compute html icon for this event
java.lang.String	getDataIconHtml(java.lang.String lang, CalendarEventInterface.IconSize size) Compute html icon for this event by specifying a size in parameter.
boolean	getDayEventFlag()
java.lang.String	getDescription(java.lang.String lang)
FileDocument[]	getDocuments()
java.util.Date	getEndDate()
long	getEventDuration() Returns the event duration
boolean	getFreeSignUp()
java.lang.String	getImportanceLevel()
java.lang.String	getLocation()
java.lang.String	getLocation(java.lang.String lang)
java.lang.String	getPeriodicity()
java.util.Date	getPeriodicityEndDate()
boolean	getPrivateFlag()
java.util.Date	getReminderDate()
long	getReminderDuration()
AbstractEventResource[]	getResources()
boolean	getSendEventUpdateMail()
java.util.Date	getStartDate()
boolean	getUseFrontOfficeCalendarEditionModal() Whether we use the Calendar edition modal in Front Office.
boolean	isAttendee(Member mbr) Check if a given member attends this calendar event (Warning: read right are not checked), either because he is in a group attending the event or else if he is in the list of attendees
boolean	isAttendee(Member mbr, boolean checkReadRight) Check if a given member attends this calendar event, either because he is in a group attending the event or else if he is in the list of attendees
boolean	isReminderEnabled()
boolean	overlapWith(CalendarEventInterface ev) Check if calendar event overlap with another one
boolean	overlapWith(java.util.Date startDate, java.util.Date endDate) Check if calendar event overlap with given interval
void	remind() remind author and attendees of event
boolean	removeAttendee(Member mbr) Remove given member from the attending members, updates the all member set.
void	setAttendingGroups(Group[] v)
void	setAttendingMembers(Member[] v)
void	setAuthorAttendee(boolean b)
void	setDocuments(FileDocument[] v)
void	setEndDate(java.util.Date date)
void	setFreeSignUp(boolean v)
void	setLocation(java.lang.String v)
void	setPeriodicity(java.lang.String v)
void	setPeriodicityEndDate(java.util.Date v)
void	setPrivateFlag(boolean v)
void	setReminderDuration(long v)
void	setResources(AbstractEventResource[] v)
void	setSendEventUpdateMail(boolean v)
void	setStartDate(java.util.Date date)
void	updateAllAttendingMembersSet() Clear and update the transient cache of all attending member set.

Method Detail

getStartDate

java.util.Date getStartDate()

getEndDate

java.util.Date getEndDate()

getImportanceLevel

java.lang.String getImportanceLevel()

getAuthorAttendee

boolean getAuthorAttendee()

setAuthorAttendee

void setAuthorAttendee(boolean b)

getDayEventFlag

boolean getDayEventFlag()

setStartDate

void setStartDate(java.util.Date date)

setEndDate

void setEndDate(java.util.Date date)

getReminderDuration

long getReminderDuration()

setReminderDuration

void setReminderDuration(long v)

getAttendingMembers

Member[] getAttendingMembers()

setAttendingMembers

void setAttendingMembers(Member[] v)

getAttendingGroups

Group[] getAttendingGroups()

setAttendingGroups

void setAttendingGroups(Group[] v)

getLocation

java.lang.String getLocation()

setLocation

void setLocation(java.lang.String v)

getPeriodicity

java.lang.String getPeriodicity()

setPeriodicity

void setPeriodicity(java.lang.String v)

getPeriodicityEndDate

java.util.Date getPeriodicityEndDate()

setPeriodicityEndDate

void setPeriodicityEndDate(java.util.Date v)

getPrivateFlag

boolean getPrivateFlag()

setPrivateFlag

void setPrivateFlag(boolean v)

getResources

AbstractEventResource[] getResources()

setResources

void setResources(AbstractEventResource[] v)

getDocuments

FileDocument[] getDocuments()

setDocuments

void setDocuments(FileDocument[] v)

getSendEventUpdateMail

boolean getSendEventUpdateMail()

setSendEventUpdateMail

void setSendEventUpdateMail(boolean v)

getFreeSignUp

boolean getFreeSignUp()

setFreeSignUp

void setFreeSignUp(boolean v)

getLocation

java.lang.String getLocation(java.lang.String lang)

getDescription

java.lang.String getDescription(java.lang.String lang)

getEventDuration

long getEventDuration()

Returns the event duration

Returns:

the event duration or -1 if start date or end date is null

overlapWith

boolean overlapWith(CalendarEventInterface ev)

Check if calendar event overlap with another one

Parameters:

ev - the other calendar event

Returns:

true if they overlap, false otherwise

Since:

jcms-4.1.1

overlapWith

boolean overlapWith(java.util.Date startDate,
                  java.util.Date endDate)

Check if calendar event overlap with given interval

Parameters:

startDate - the start date of the interval to check

endDate - the end date of the interval to check

Returns:

true if event overlap with given interval, false otherwise

Since:

jcms-4.1.1

isAttendee

boolean isAttendee(Member mbr)

Check if a given member attends this calendar event (Warning: read right are not checked), either because he is in a group attending the event or else if he is in the list of attendees

Parameters:

mbr - the member to check

Returns:

true if the member attends the event, false otherwise

isAttendee

boolean isAttendee(Member mbr,
                 boolean checkReadRight)

Check if a given member attends this calendar event, either because he is in a group attending the event or else if he is in the list of attendees

Parameters:

mbr - the member to check

checkReadRight - set to true if read right should be checked (in which case a member is considered attendee only when is can read the event), set to false if read right should not be checked (in which case a member is considered attendee event if he cannot read the event)

Returns:

true if the member attends the event, false otherwise

Since:

jcms-6.1.3

isReminderEnabled

boolean isReminderEnabled()

Returns:

true if reminder is enabled, false otherwise

Since:

jcms-4.1.1

getReminderDate

java.util.Date getReminderDate()

Returns:

the reminder date

Since:

jcms-4.1.1

getAllAttendingMembersSet

java.util.TreeSet<Member> getAllAttendingMembersSet()

Return a set containing all the members attending this event. Contains all members from the attendees groups and the attendees member, who can read this calendar event (this set is built and cached on create/update of event).

Returns:

a TreeSet of all member attending to this event

Since:

jcms-5.0.0

getAllAttendingMembersSet

java.util.TreeSet<Member> getAllAttendingMembersSet(boolean checkReadRight)

Return a set containing all the members attending this event checking for readright or not. Contains all members from the attendees groups and the attendees member, (this set is built and cached on create/update of event).

Parameters:

checkReadRight - set to true if read right should be checked, false if all attendee should be included even Member not able to read the event

Returns:

a TreeSet of all member attending to this event

Since:

jcms-6.1.3

getAttendingMemberSet

java.util.TreeSet<Member> getAttendingMemberSet()

Retrieve the attending members as a Set, with the author included.

Returns:

the set of attending members corresponding to attenginmembers with author added, never return null

Since:

jcms-6.1.1

removeAttendee

boolean removeAttendee(Member mbr)

Remove given member from the attending members, updates the all member set. Note: Does not perform update in store, this method must be called on the clone to be updated.

Parameters:

mbr - the Member to remove

Returns:

true if a modification was made

Since:

jcms-5.0.0

updateAllAttendingMembersSet

void updateAllAttendingMembersSet()

Clear and update the transient cache of all attending member set.

Since:

jcms-5.0.1

remind

void remind()

remind author and attendees of event

Since:

jcms-4.1.1

getDataIconHtml

java.lang.String getDataIconHtml()

Compute html icon for this event

Returns:

the html string of the icon

getDataIconHtml

java.lang.String getDataIconHtml(java.lang.String lang,
                               CalendarEventInterface.IconSize size)

Compute html icon for this event by specifying a size in parameter.

Parameters:

lang - the user language.

size - icon size

Returns:

the html string of the icon

Since:

jcms-8

getUseFrontOfficeCalendarEditionModal

boolean getUseFrontOfficeCalendarEditionModal()

Whether we use the Calendar edition modal in Front Office.

Returns:

true if we use the Calendar edition modal.

Since:

jcms-8