com.jalios.jcms.calendar
Class AbstractCalendarEvent

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.Publication
              com.jalios.jcms.Content
                  com.jalios.jcms.calendar.AbstractCalendarEvent

All Implemented Interfaces:

CalendarEventInterface, EditableData, JcmsConstants, ImportConstants, MashupConstants, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, Cloneable, Comparable<BasicStorable>

public abstract class AbstractCalendarEvent
extends Content
implements CalendarEventInterface

This abstract class provides a superclass to every calendar event and base methods for their manipulation

Since:

jcms-4.1.1

Version:

$Revision: 36899 $

Author:

Olivier Jaquemet

Nested Class Summary

static class	AbstractCalendarEvent.CalendarEventAttendeeSelector This DataSelector selects all the CalendarEvent of which the given member is an attendee (either because he is the author or he is in the list of attendees).
static class	AbstractCalendarEvent.CalendarEventDateSelector This DataSelector selects all the CalendarEvent taking place in between the given date
static class	AbstractCalendarEvent.StartDateComparator<T extends CalendarEventInterface> This comparator allow sorting of calendar event in chronological order using only their start date

Nested classes/interfaces inherited from class com.jalios.jcms.Publication

Publication.AdateComparator<T extends Publication>, Publication.AdateSelector, Publication.AudienceRightComparator<T extends Publication>, Publication.AudienceRightSelector, Publication.AuthorComparator<T extends Publication>, Publication.AuthorizedSelector, Publication.CanWorkOnSelector, Publication.DdateComparator<T extends Publication>, Publication.EdateComparator<T extends Publication>, Publication.EdateSelector, Publication.PdateComparator<T extends Publication>, Publication.PdateSelector, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.RatingComparator<T extends Publication>, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.ReviewCountComparator<T extends Publication>, Publication.RightComparator<T extends Publication>, Publication.SdateComparator<T extends Publication>, Publication.SdateSelector, Publication.TitleComparator<T extends Publication>, Publication.TrackedSelector, Publication.TypeComparator<T extends Publication>, Publication.UdateComparator<T extends Publication>, Publication.UdateSelector, Publication.UserContentSelector, Publication.VisibleStateSelector, Publication.WorkspaceAuthorSelector, Publication.WorkspaceComparator<T extends Publication>, Publication.WorkspaceSelector

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

static String

REVISION

Fields inherited from class com.jalios.jcms.Publication

adate, allCatIdSet, authGrpIdSet, authGrpIdSetDirty, authGrpIdSetInit, authMbrIdSet, authMbrIdSetDirty, authMbrIdSetInit, authorizedGroupSet, authorizedMemberSet, categories, categorySet, catIdSet, catIdSetDirty, catIdSetInit, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, hasNoReadRightsDBData, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, readerCount, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, workspace

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

AbstractCalendarEvent()

AbstractCalendarEvent(Content other)

Method Summary

ControllerStatus	checkIntegrity() Checks whether or not data integrity constraints are respected.
TreeSet<Member>	getAllAttendingMembersSet() Return a set containing all the members attending this event.
TreeSet<Member>	getAllAttendingMembersSet(boolean checkReadRight) Return a set containing all the members attending this event checking for readright or not.
abstract Group[]	getAttendingGroups()
abstract Member[]	getAttendingMembers()
TreeSet<Member>	getAttendingMemberSet() Retrieve the attending members as a Set, with the author included.
abstract boolean	getAuthorAttendee()
static AbstractCalendarEvent.CalendarEventAttendeeSelector	getCalendarEventAttendeeSelector(Member mbr)
static AbstractCalendarEvent.CalendarEventAttendeeSelector	getCalendarEventAttendeeSelector(Member mbr, boolean checkReadRight)
static AbstractCalendarEvent.CalendarEventDateSelector	getCalendarEventDateSelector(Date startDate, Date endDate)
static AbstractCalendarEvent.CalendarEventDateSelector	getCalendarEventDateSelector(Date startDate, Date endDate, boolean dayEventFlag) Create a DataSelector for AbstractCalendarEvent
abstract boolean	getDayEventFlag()
abstract String	getDescription(String lang)
abstract FileDocument[]	getDocuments()
abstract Date	getEndDate()
long	getEventDuration() Returns the event duration
abstract boolean	getFreeSignUp()
String	getHtmlIcon() Compute html icon for this event
abstract String	getImportanceLevel()
abstract String	getLocation()
abstract String	getLocation(String lang)
abstract String	getPeriodicity()
abstract boolean	getPrivateFlag()
Date	getReminderDate()
abstract long	getReminderDuration()
abstract AbstractEventResource[]	getResources()
abstract boolean	getSendEventUpdateMail()
abstract Date	getStartDate()
static AbstractCalendarEvent.StartDateComparator<CalendarEventInterface>	getStartDateComparator()
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(Date startDate, Date endDate) Check if calendar event overlap with given interval
void	performCreate(Member mbr, Map context) Performs additionnal task during creation of CalendarEvent. - Synchronize the SDate with the StartDate.
void	performUpdate(Member mbr, Map context) Performs additionnal task during update of CalendarEvent. - Synchronize the SDate with the StartDate.
void	remind() remind author and attendees of event
boolean	removeAttendee(Member mbr) Remove given member from the attending members, updates the all member set.
abstract void	setAttendingGroups(Group[] v)
abstract void	setAttendingMembers(Member[] v)
abstract void	setAuthorAttendee(boolean b)
abstract void	setDocuments(FileDocument[] v)
abstract void	setEndDate(Date date)
abstract void	setFreeSignUp(boolean v)
abstract void	setLocation(String v)
abstract void	setPeriodicity(String v)
abstract void	setPrivateFlag(boolean v)
abstract void	setReminderDuration(long v)
abstract void	setResources(AbstractEventResource[] v)
abstract void	setSendEventUpdateMail(boolean v)
abstract void	setStartDate(Date date)
void	updateAllAttendingMembersSet() Clear and update the transient cache of all attending member set.

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, checkCreate, checkDelete, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, cloneDBDataCollections, computeSignature, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, exportXmlField, getAbstract, getAbstract, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllFilePath, getAllWikiText, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getComparator, getComparator, getComparator, getCSVHeader, getDataName, getDate, getDate, getDateSelector, getDBDataRevision, getDdateComparator, getDefaultTemplateUsage, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getGlobalRating, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getRatingComparator, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getReview, getReviewCount, getReviewCountComparator, getReviewList, getReviewList, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTrackedSelector, getTreeChildren, getTreeParent, getTreeRoot, getTypeComparator, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasReview, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, initializeDBDataCollections, internalCanBeReadBy, isAudienced, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isTreeLeaf, isTreeNode, isUserContent, isUserContentType, isVersioned, isWorkCopy, majorUpdate, notifyFollowers, performAfterWrite, performBeforeWrite, performDelete, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCatIdSet, setCdate, setEdate, setFieldValue, setFriendlyURLSet, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReaderCount, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

canRequestLock, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.jcms.calendar.CalendarEventInterface

getPeriodicityEndDate, setPeriodicityEndDate

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

AbstractCalendarEvent

public AbstractCalendarEvent()

AbstractCalendarEvent

public AbstractCalendarEvent(Content other)

Method Detail

getStartDate

public abstract Date getStartDate()

Specified by:

getStartDate in interface CalendarEventInterface

getEndDate

public abstract Date getEndDate()

Specified by:

getEndDate in interface CalendarEventInterface

getImportanceLevel

public abstract String getImportanceLevel()

Specified by:

getImportanceLevel in interface CalendarEventInterface

getAuthorAttendee

public abstract boolean getAuthorAttendee()

Specified by:

getAuthorAttendee in interface CalendarEventInterface

setAuthorAttendee

public abstract void setAuthorAttendee(boolean b)

Specified by:

setAuthorAttendee in interface CalendarEventInterface

getDayEventFlag

public abstract boolean getDayEventFlag()

Specified by:

getDayEventFlag in interface CalendarEventInterface

setStartDate

public abstract void setStartDate(Date date)

Specified by:

setStartDate in interface CalendarEventInterface

setEndDate

public abstract void setEndDate(Date date)

Specified by:

setEndDate in interface CalendarEventInterface

getEventDuration

public long getEventDuration()

Description copied from interface: CalendarEventInterface

Returns the event duration

Specified by:

getEventDuration in interface CalendarEventInterface

Returns:

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

overlapWith

public boolean overlapWith(CalendarEventInterface ev)

Description copied from interface: CalendarEventInterface

Check if calendar event overlap with another one

Specified by:

overlapWith in interface CalendarEventInterface

Parameters:

ev - the other calendar event

Returns:

true if they overlap, false otherwise

overlapWith

public boolean overlapWith(Date startDate,
                           Date endDate)

Description copied from interface: CalendarEventInterface

Check if calendar event overlap with given interval

Specified by:

overlapWith in interface CalendarEventInterface

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

getCalendarEventDateSelector

public static AbstractCalendarEvent.CalendarEventDateSelector getCalendarEventDateSelector(Date startDate,
                                                                                           Date endDate)

getCalendarEventDateSelector

public static AbstractCalendarEvent.CalendarEventDateSelector getCalendarEventDateSelector(Date startDate,
                                                                                           Date endDate,
                                                                                           boolean dayEventFlag)

Create a DataSelector for AbstractCalendarEvent

Parameters:

startDate - the start date of selection

endDate - the end date of selection

dayEventFlag - true if only day event should be selected, false if only standard event is selected

Returns:

the AbstractCalendarEvent.CalendarEventDateSelector

getStartDateComparator

public static AbstractCalendarEvent.StartDateComparator<CalendarEventInterface> getStartDateComparator()

Returns:

a new instance of StartDateComparator

isAttendee

public boolean isAttendee(Member mbr)

Description copied from interface: CalendarEventInterface

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

Specified by:

isAttendee in interface CalendarEventInterface

Parameters:

mbr - the member to check

Returns:

true if the member attends the event, false otherwise

isAttendee

public boolean isAttendee(Member mbr,
                          boolean checkReadRight)

Description copied from interface: CalendarEventInterface

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

Specified by:

isAttendee in interface CalendarEventInterface

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

getCalendarEventAttendeeSelector

public static AbstractCalendarEvent.CalendarEventAttendeeSelector getCalendarEventAttendeeSelector(Member mbr)

Parameters:

mbr - the member to select the calendar event

Returns:

a new instance of CalendarEventAttendeeSelector initialiazed with the given member

getCalendarEventAttendeeSelector

public static AbstractCalendarEvent.CalendarEventAttendeeSelector getCalendarEventAttendeeSelector(Member mbr,
                                                                                                   boolean checkReadRight)

Parameters:

mbr - the member to select the calendar event

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

Returns:

a new instance of CalendarEventAttendeeSelector initialiazed with the given member

Since:

jcms-6.1.3, jcms-7.0

getReminderDuration

public abstract long getReminderDuration()

Specified by:

getReminderDuration in interface CalendarEventInterface

setReminderDuration

public abstract void setReminderDuration(long v)

Specified by:

setReminderDuration in interface CalendarEventInterface

getAttendingMembers

public abstract Member[] getAttendingMembers()

Specified by:

getAttendingMembers in interface CalendarEventInterface

setAttendingMembers

public abstract void setAttendingMembers(Member[] v)

Specified by:

setAttendingMembers in interface CalendarEventInterface

getAttendingGroups

public abstract Group[] getAttendingGroups()

Specified by:

getAttendingGroups in interface CalendarEventInterface

setAttendingGroups

public abstract void setAttendingGroups(Group[] v)

Specified by:

setAttendingGroups in interface CalendarEventInterface

isReminderEnabled

public boolean isReminderEnabled()

Specified by:

isReminderEnabled in interface CalendarEventInterface

Returns:

true if reminder is enabled, false otherwise

getReminderDate

public Date getReminderDate()

Specified by:

getReminderDate in interface CalendarEventInterface

Returns:

the reminder date

getAllAttendingMembersSet

public TreeSet<Member> getAllAttendingMembersSet()

Description copied from interface: CalendarEventInterface

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).

Specified by:

getAllAttendingMembersSet in interface CalendarEventInterface

Returns:

a TreeSet of all member attending to this event

getAllAttendingMembersSet

public TreeSet<Member> getAllAttendingMembersSet(boolean checkReadRight)

Description copied from interface: CalendarEventInterface

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).

Specified by:

getAllAttendingMembersSet in interface CalendarEventInterface

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

getAttendingMemberSet

public TreeSet<Member> getAttendingMemberSet()

Description copied from interface: CalendarEventInterface

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

Specified by:

getAttendingMemberSet in interface CalendarEventInterface

Returns:

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

removeAttendee

public boolean removeAttendee(Member mbr)

Description copied from interface: CalendarEventInterface

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.

Specified by:

removeAttendee in interface CalendarEventInterface

Parameters:

mbr - the Member to remove

Returns:

true if a modification was made

updateAllAttendingMembersSet

public void updateAllAttendingMembersSet()

Description copied from interface: CalendarEventInterface

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

Specified by:

updateAllAttendingMembersSet in interface CalendarEventInterface

remind

public void remind()

Description copied from interface: CalendarEventInterface

remind author and attendees of event

Specified by:

remind in interface CalendarEventInterface

checkIntegrity

public ControllerStatus checkIntegrity()

Checks whether or not data integrity constraints are respected.

Overrides:

checkIntegrity in class Publication

Returns:

a ControllerStatus

Since:

jcms-5.0.0

performCreate

public void performCreate(Member mbr,
                          Map context)

Performs additionnal task during creation of CalendarEvent. - Synchronize the SDate with the StartDate.

Overrides:

performCreate in class Publication

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Since:

jcms-5.5.0

performUpdate

public void performUpdate(Member mbr,
                          Map context)

Performs additionnal task during update of CalendarEvent. - Synchronize the SDate with the StartDate.

Overrides:

performUpdate in class Publication

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Since:

jcms-5.5.0

setFreeSignUp

public abstract void setFreeSignUp(boolean v)

Specified by:

setFreeSignUp in interface CalendarEventInterface

getFreeSignUp

public abstract boolean getFreeSignUp()

Specified by:

getFreeSignUp in interface CalendarEventInterface

setSendEventUpdateMail

public abstract void setSendEventUpdateMail(boolean v)

Specified by:

setSendEventUpdateMail in interface CalendarEventInterface

getSendEventUpdateMail

public abstract boolean getSendEventUpdateMail()

Specified by:

getSendEventUpdateMail in interface CalendarEventInterface

setDocuments

public abstract void setDocuments(FileDocument[] v)

Specified by:

setDocuments in interface CalendarEventInterface

getDocuments

public abstract FileDocument[] getDocuments()

Specified by:

getDocuments in interface CalendarEventInterface

setResources

public abstract void setResources(AbstractEventResource[] v)

Specified by:

setResources in interface CalendarEventInterface

getResources

public abstract AbstractEventResource[] getResources()

Specified by:

getResources in interface CalendarEventInterface

setPrivateFlag

public abstract void setPrivateFlag(boolean v)

Specified by:

setPrivateFlag in interface CalendarEventInterface

getPrivateFlag

public abstract boolean getPrivateFlag()

Specified by:

getPrivateFlag in interface CalendarEventInterface

setPeriodicity

public abstract void setPeriodicity(String v)

Specified by:

setPeriodicity in interface CalendarEventInterface

getPeriodicity

public abstract String getPeriodicity()

Specified by:

getPeriodicity in interface CalendarEventInterface

setLocation

public abstract void setLocation(String v)

Specified by:

setLocation in interface CalendarEventInterface

getLocation

public abstract String getLocation()

Specified by:

getLocation in interface CalendarEventInterface

getLocation

public abstract String getLocation(String lang)

Specified by:

getLocation in interface CalendarEventInterface

getDescription

public abstract String getDescription(String lang)

Specified by:

getDescription in interface CalendarEventInterface

getHtmlIcon

public String getHtmlIcon()

Description copied from interface: CalendarEventInterface

Compute html icon for this event

Specified by:

getHtmlIcon in interface CalendarEventInterface

Returns:

the html string of the icon