Class JCRCalendarEvent
java.lang.Object
org.ametys.plugins.repository.AbstractAmetysObject
org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>
org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<JCRCalendarEventFactory>
org.ametys.plugins.workspaces.calendars.jcr.JCRCalendarEvent
- All Implemented Interfaces:
ModelAwareDataAwareAmetysObject
,ModifiableModelAwareDataAwareAmetysObject
,IndexableDataHolder
,ModifiableIndexableDataHolder
,ACLAmetysObject
,AmetysObject
,DataAwareAmetysObject
,ModelAwareDataAwareAmetysObject
,ModifiableModelAwareDataAwareAmetysObject
,DataHolder
,ModelAwareDataHolder
,ModifiableDataHolder
,ModifiableModelAwareDataHolder
,JCRAmetysObject
,JCRTraversableAmetysObject
,MetadataAwareAmetysObject
,ModifiableMetadataAwareAmetysObject
,ModifiableACLAmetysObject
,ModifiableAmetysObject
,ModifiableTraversableAmetysObject
,RemovableAmetysObject
,TagAwareAmetysObject
,TaggableAmetysObject
,TraversableAmetysObject
,WorkflowAwareAmetysObject
,CalendarEvent
,ModifiableCalendarEvent
public class JCRCalendarEvent
extends DefaultTraversableAmetysObject<JCRCalendarEventFactory>
implements ModifiableCalendarEvent
Default implementation of an
CalendarEvent
, backed by a JCR node.-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Attribute name for event last contributorstatic final String
Attribute name for event lastModifiedstatic final String
Attribute name for event authorstatic final String
Attribute name for event date sonestatic final String
Attribute name for event descriptionstatic final String
Attribute name for event endDatestatic final String
Attribute name for event excluded datestatic final String
Attribute name for event fullDaystatic final String
Attribute name for event keywords'static final String
Attribute name for event locationstatic final String
Attribute name for event lastModifiedstatic final String
Attribute name for event organiserstatic final String
Attribute name for event recurrence typestatic final String
Property's name for resourcesstatic final String
Attribute name for event startDatestatic final String
Attribute name for event titlestatic final String
Attribute name for event until datestatic final String
Name of the node for attendee *static final String
Name of the node for attendees *static final String
Property name for attendee email *static final String
Property name for attendee external *static final String
Property name for attendee login *static final String
Property name for attendee mandatory *static final String
Property name for attendee population *static final String
Property's name for workflow idFields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX
-
Constructor Summary
ConstructorDescriptionJCRCalendarEvent
(javax.jcr.Node node, String parentPath, JCRCalendarEventFactory factory) Creates anJCRCalendarEvent
. -
Method Summary
Modifier and TypeMethodDescriptionGet attendees to the eventRetrieves the creation date.Retrieves the the creator.long
Retrieves the current step id of the Ametys objectReturns theDataHolder
of thisAmetysObject
.Get the description of the eventGet the date of the end of the eventRetrieves the list of excluded event date.Retrieves the start date of the first Event which end after the dateGet if the event last all the dayRetrieves the last contributor.Retrieves the last modification date.Get the location of the eventgetNextOccurrence
(CalendarEventOccurrence occurrence) Retrieves the date of the next event after the dategetOccurrences
(ZonedDateTime startDate, ZonedDateTime endDate) Retrieves the list of all event date between startDate and endDate.Retrieves the organiser.Retrieves the recurrence type.Retrieves the end date of the frequency.Retrieves the resource list.Get the date of the begin of the eventgetTags()
Retrieves current tags.getTitle()
Get the title of the eventlong
Retrieves the workflow id associated with the Ametys object.getZone()
Get the date zone of the eventRetrieves if the event is recurrent.void
setAttendees
(List<CalendarEventAttendee> attendees) Set attendees to the eventvoid
setCreationDate
(ZonedDateTime date) Set the creation datevoid
setCreator
(UserIdentity user) Set the creatorvoid
setCurrentStepId
(long stepId) Set the current step id of the Ametys objectvoid
setDescription
(String desc) Set the description of the eventvoid
setEndDate
(ZonedDateTime endDate) Set the endDate of the eventvoid
setExcludedOccurrences
(List<ZonedDateTime> excludedOccurrences) Set the list of excluded event date.void
setFullDay
(Boolean fullDay) Set if the event last all the dayvoid
Set the last contributorvoid
setLastModified
(ZonedDateTime date) Set the last modified datevoid
setLocation
(String location) Set the location of the eventvoid
setOrganiser
(UserIdentity user) Set the oragniservoid
setRecurrenceType
(String recurrenceType) Set the recurrence type.void
setRepeatUntil
(ZonedDateTime untilDate) Set the end date of the frequency.void
setResources
(List<String> resources) Set the resourcesvoid
setStartDate
(ZonedDateTime startDate) Set the startDate of the eventvoid
Set the title of the eventvoid
setWorkflowId
(long workflowId) Set the workflow id of this Ametys object.
This method will throw Exception if the workflow id was already set on this Ametys object.void
Set the date zone of the eventvoid
Tags.void
Untags.Methods inherited from class org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject
addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, disallowInheritance, getChild, getChildren, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, hasChild, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers
Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject
_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges
Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ametys.plugins.repository.AmetysObject
equals, getId, getName, getParent, getParentPath, getPath, hashCode
Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject
copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX
Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject
getNode
Methods inherited from interface org.ametys.cms.data.ametysobject.ModelAwareDataAwareAmetysObject
getSystemPropertyExtensionPoint, indexData, indexData
Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareDataAwareAmetysObject
dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty
Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultiple
Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject
needsSave, rename, revertChanges, saveChanges
Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder
getRepositoryData
Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject
getMetadataHolder
Methods inherited from interface org.ametys.cms.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject
getComposite, getComposite, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRootDataHolder
Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject
getRepositoryData, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues
Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject
remove
Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject
getChildAt, getChildPosition
-
Field Details
-
ATTRIBUTE_CREATOR
Attribute name for event author- See Also:
-
ATTRIBUTE_CREATION
Attribute name for event lastModified- See Also:
-
ATTRIBUTE_CONTRIBUTOR
Attribute name for event last contributor- See Also:
-
ATTRIBUTE_MODIFIED
Attribute name for event lastModified- See Also:
-
ATTRIBUTE_TITLE
Attribute name for event title- See Also:
-
ATTRIBUTE_DESC
Attribute name for event description- See Also:
-
ATTRIBUTE_KEYWORDS
Attribute name for event keywords'- See Also:
-
ATTRIBUTE_LOCATION
Attribute name for event location- See Also:
-
ATTRIBUTE_START_DATE
Attribute name for event startDate- See Also:
-
ATTRIBUTE_END_DATE
Attribute name for event endDate- See Also:
-
ATTRIBUTE_DATE_ZONE
Attribute name for event date sone- See Also:
-
ATTRIBUTE_FULL_DAY
Attribute name for event fullDay- See Also:
-
ATTRIBUTE_RECURRENCE_TYPE
Attribute name for event recurrence type- See Also:
-
ATTRIBUTE_UNTIL_DATE
Attribute name for event until date- See Also:
-
ATTRIBUTE_EXCLUDED_DATE
Attribute name for event excluded date- See Also:
-
ATTRIBUTE_ORGANISER
Attribute name for event organiser- See Also:
-
PROPERTY_ATTENDEE_POPULATION
Property name for attendee population *- See Also:
-
PROPERTY_ATTENDEE_LOGIN
Property name for attendee login *- See Also:
-
PROPERTY_ATTENDEE_EMAIL
Property name for attendee email *- See Also:
-
PROPERTY_ATTENDEE_EXTERNAL
Property name for attendee external *- See Also:
-
PROPERTY_ATTENDEE_MANDATORY
Property name for attendee mandatory *- See Also:
-
NODE_ATTENDEES_NAME
Name of the node for attendees *- See Also:
-
NODE_ATTENDEE_NAME
Name of the node for attendee *- See Also:
-
PROPERTY_WORKFLOW_ID
Property's name for workflow id- See Also:
-
ATTRIBUTE_RESOURCES
Property's name for resources- See Also:
-
-
Constructor Details
-
JCRCalendarEvent
Creates anJCRCalendarEvent
.- Parameters:
node
- the node backing thisAmetysObject
parentPath
- the parentPath in the Ametys hierarchyfactory
- the DefaultAmetysObjectFactory which created the AmetysObject
-
-
Method Details
-
getTitle
Description copied from interface:CalendarEvent
Get the title of the event- Specified by:
getTitle
in interfaceCalendarEvent
- Returns:
- the title of the event
-
getDescription
Description copied from interface:CalendarEvent
Get the description of the event- Specified by:
getDescription
in interfaceCalendarEvent
- Returns:
- the description of the event
-
getLocation
Description copied from interface:CalendarEvent
Get the location of the event- Specified by:
getLocation
in interfaceCalendarEvent
- Returns:
- the location of the event
-
tag
Description copied from interface:TaggableAmetysObject
Tags.- Specified by:
tag
in interfaceTaggableAmetysObject
- Parameters:
tag
- the tag to add.- Throws:
AmetysRepositoryException
- if an error occurs.
-
untag
Description copied from interface:TaggableAmetysObject
Untags.- Specified by:
untag
in interfaceTaggableAmetysObject
- Parameters:
tag
- the tag to remove.- Throws:
AmetysRepositoryException
- if an error occurs.
-
getTags
Description copied from interface:TagAwareAmetysObject
Retrieves current tags.- Specified by:
getTags
in interfaceTagAwareAmetysObject
- Returns:
- the current tags.
- Throws:
AmetysRepositoryException
- if an error occurs.
-
getStartDate
Description copied from interface:CalendarEvent
Get the date of the begin of the event- Specified by:
getStartDate
in interfaceCalendarEvent
- Returns:
- the date of the event
-
getEndDate
Description copied from interface:CalendarEvent
Get the date of the end of the event- Specified by:
getEndDate
in interfaceCalendarEvent
- Returns:
- the date of the event
-
getZone
Description copied from interface:CalendarEvent
Get the date zone of the event- Specified by:
getZone
in interfaceCalendarEvent
- Returns:
- the date zone of the event
-
getFullDay
Description copied from interface:CalendarEvent
Get if the event last all the day- Specified by:
getFullDay
in interfaceCalendarEvent
- Returns:
- true if the event last all the day
-
getCreator
Description copied from interface:CalendarEvent
Retrieves the the creator.- Specified by:
getCreator
in interfaceCalendarEvent
- Returns:
- the creator.
-
getCreationDate
Description copied from interface:CalendarEvent
Retrieves the creation date.- Specified by:
getCreationDate
in interfaceCalendarEvent
- Returns:
- the creation date.
-
getLastContributor
Description copied from interface:CalendarEvent
Retrieves the last contributor.- Specified by:
getLastContributor
in interfaceCalendarEvent
- Returns:
- the last contributor.
-
getLastModified
Description copied from interface:CalendarEvent
Retrieves the last modification date.- Specified by:
getLastModified
in interfaceCalendarEvent
- Returns:
- the last modification date.
-
getRecurrenceType
Description copied from interface:CalendarEvent
Retrieves the recurrence type.- Specified by:
getRecurrenceType
in interfaceCalendarEvent
- Returns:
- the recurrence type.
-
isRecurrent
Description copied from interface:CalendarEvent
Retrieves if the event is recurrent.- Specified by:
isRecurrent
in interfaceCalendarEvent
- Returns:
- true if the event is recurrent.
-
getRepeatUntil
Description copied from interface:CalendarEvent
Retrieves the end date of the frequency.- Specified by:
getRepeatUntil
in interfaceCalendarEvent
- Returns:
- the end date of the frequency.
-
getExcludedOccurences
Description copied from interface:CalendarEvent
Retrieves the list of excluded event date.- Specified by:
getExcludedOccurences
in interfaceCalendarEvent
- Returns:
- the list of excluded event date.
-
getOrganiser
Description copied from interface:CalendarEvent
Retrieves the organiser.- Specified by:
getOrganiser
in interfaceCalendarEvent
- Returns:
- the organiser.
-
getResources
Description copied from interface:CalendarEvent
Retrieves the resource list.- Specified by:
getResources
in interfaceCalendarEvent
- Returns:
- the resource list.
-
setTitle
Description copied from interface:ModifiableCalendarEvent
Set the title of the event- Specified by:
setTitle
in interfaceModifiableCalendarEvent
- Parameters:
title
- the title
-
setDescription
Description copied from interface:ModifiableCalendarEvent
Set the description of the event- Specified by:
setDescription
in interfaceModifiableCalendarEvent
- Parameters:
desc
- the description
-
setLocation
Description copied from interface:ModifiableCalendarEvent
Set the location of the event- Specified by:
setLocation
in interfaceModifiableCalendarEvent
- Parameters:
location
- the location
-
setStartDate
Description copied from interface:ModifiableCalendarEvent
Set the startDate of the event- Specified by:
setStartDate
in interfaceModifiableCalendarEvent
- Parameters:
startDate
- the start date
-
setEndDate
Description copied from interface:ModifiableCalendarEvent
Set the endDate of the event- Specified by:
setEndDate
in interfaceModifiableCalendarEvent
- Parameters:
endDate
- the end date
-
setZone
Description copied from interface:ModifiableCalendarEvent
Set the date zone of the event- Specified by:
setZone
in interfaceModifiableCalendarEvent
- Parameters:
dateZone
- the date zone
-
setFullDay
Description copied from interface:ModifiableCalendarEvent
Set if the event last all the day- Specified by:
setFullDay
in interfaceModifiableCalendarEvent
- Parameters:
fullDay
- is a fullday event
-
setCreator
Description copied from interface:ModifiableCalendarEvent
Set the creator- Specified by:
setCreator
in interfaceModifiableCalendarEvent
- Parameters:
user
- The creator
-
setCreationDate
Description copied from interface:ModifiableCalendarEvent
Set the creation date- Specified by:
setCreationDate
in interfaceModifiableCalendarEvent
- Parameters:
date
- The creation date
-
setLastContributor
Description copied from interface:ModifiableCalendarEvent
Set the last contributor- Specified by:
setLastContributor
in interfaceModifiableCalendarEvent
- Parameters:
user
- The last contributor
-
setLastModified
Description copied from interface:ModifiableCalendarEvent
Set the last modified date- Specified by:
setLastModified
in interfaceModifiableCalendarEvent
- Parameters:
date
- The last modified date
-
setRecurrenceType
Description copied from interface:ModifiableCalendarEvent
Set the recurrence type.- Specified by:
setRecurrenceType
in interfaceModifiableCalendarEvent
- Parameters:
recurrenceType
- the recurrence type
-
setRepeatUntil
Description copied from interface:ModifiableCalendarEvent
Set the end date of the frequency.- Specified by:
setRepeatUntil
in interfaceModifiableCalendarEvent
- Parameters:
untilDate
- the end date of the recurrence
-
setExcludedOccurrences
Description copied from interface:ModifiableCalendarEvent
Set the list of excluded event date.- Specified by:
setExcludedOccurrences
in interfaceModifiableCalendarEvent
- Parameters:
excludedOccurrences
- excluded date
-
getOccurrences
Description copied from interface:CalendarEvent
Retrieves the list of all event date between startDate and endDate.- Specified by:
getOccurrences
in interfaceCalendarEvent
- Parameters:
startDate
- the start dateendDate
- the end date- Returns:
- the list of all event date between startDate and endDate.
-
getFirstOccurrence
Description copied from interface:CalendarEvent
Retrieves the start date of the first Event which end after the date- Specified by:
getFirstOccurrence
in interfaceCalendarEvent
- Parameters:
date
- the date- Returns:
- the start date of the first Event which end after the date
-
getNextOccurrence
Description copied from interface:CalendarEvent
Retrieves the date of the next event after the date- Specified by:
getNextOccurrence
in interfaceCalendarEvent
- Parameters:
occurrence
- the current occurrence- Returns:
- the occurrence of the next event after the date
-
getWorkflowId
Description copied from interface:WorkflowAwareAmetysObject
Retrieves the workflow id associated with the Ametys object.- Specified by:
getWorkflowId
in interfaceWorkflowAwareAmetysObject
- Returns:
- the workflow id.
- Throws:
AmetysRepositoryException
- if an error occurs.
-
setWorkflowId
Description copied from interface:WorkflowAwareAmetysObject
Set the workflow id of this Ametys object.
This method will throw Exception if the workflow id was already set on this Ametys object.- Specified by:
setWorkflowId
in interfaceWorkflowAwareAmetysObject
- Parameters:
workflowId
- the workflow id of the object.- Throws:
AmetysRepositoryException
- if an error occurs.
-
getCurrentStepId
Description copied from interface:WorkflowAwareAmetysObject
Retrieves the current step id of the Ametys object- Specified by:
getCurrentStepId
in interfaceWorkflowAwareAmetysObject
- Returns:
- the current step id
-
setCurrentStepId
Description copied from interface:WorkflowAwareAmetysObject
Set the current step id of the Ametys object- Specified by:
setCurrentStepId
in interfaceWorkflowAwareAmetysObject
- Parameters:
stepId
- the step id to set
-
setOrganiser
Description copied from interface:ModifiableCalendarEvent
Set the oragniser- Specified by:
setOrganiser
in interfaceModifiableCalendarEvent
- Parameters:
user
- The oragniser
-
getAttendees
Get attendees to the event- Returns:
- the attendees
- Throws:
javax.jcr.RepositoryException
- if an error occurred
-
setAttendees
public void setAttendees(List<CalendarEventAttendee> attendees) throws javax.jcr.RepositoryException Set attendees to the event- Parameters:
attendees
- the list of attendees- Throws:
javax.jcr.RepositoryException
- if an error occurred
-
setResources
Description copied from interface:ModifiableCalendarEvent
Set the resources- Specified by:
setResources
in interfaceModifiableCalendarEvent
- Parameters:
resources
- The resources
-
getDataHolder
Description copied from interface:DataAwareAmetysObject
Returns theDataHolder
of thisAmetysObject
.- Specified by:
getDataHolder
in interfaceDataAwareAmetysObject
- Specified by:
getDataHolder
in interfaceModelAwareDataAwareAmetysObject
- Specified by:
getDataHolder
in interfaceModelAwareDataAwareAmetysObject
- Specified by:
getDataHolder
in interfaceModifiableModelAwareDataAwareAmetysObject
- Specified by:
getDataHolder
in interfaceModifiableModelAwareDataAwareAmetysObject
- Returns:
- the
DataHolder
of thisAmetysObject
-