Package org.ametys.plugins.explorer.calendars.jcr

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.explorer.calendars.jcr.JCRCalendarEvent

All Implemented Interfaces:

CalendarEvent, ModifiableCalendarEvent, ACLAmetysObject, AmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, WorkflowAwareAmetysObject

public class JCRCalendarEvent
extends DefaultTraversableAmetysObject<JCRCalendarEventFactory>
implements ModifiableCalendarEvent

Default implementation of an CalendarEvent, backed by a JCR node.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_CONTRIBUTOR	Metadata's name for last contributor's event*
static final String	METADATA_CREATION	Metadata's name for lastModified's event*
static final String	METADATA_CREATOR	Metadata's name for author's event*
static final String	METADATA_DESC	Metadata's name for description's event*
static final String	METADATA_END_DATE	Metadata's name for endDate's event*
static final String	METADATA_EXCLUDED_DATE	Metadata's name for excluded date event*
static final String	METADATA_FULL_DAY	Metadata's name for fullDay's event*
static final String	METADATA_KEYWORDS	Metadata's name for keywords' event*
static final String	METADATA_LOCATION	Metadata's name for location's event*
static final String	METADATA_MODIFIED	Metadata's name for lastModified's event*
static final String	METADATA_ORGANISER	Metadata's name for organiser's event*
static final String	METADATA_RECURRENCE_TYPE	Metadata's name for recurrence type event*
static final String	METADATA_START_DATE	Metadata's name for startDate's event*
static final String	METADATA_TITLE	Metadata's name for title's event*
static final String	METADATA_UNTIL_DATE	Metadata's name for until date event*
static final String	METADATA_VALIDATED	Metadata's name for last validated date's event*
static final String	METADATA_VALIDATOR	Metadata's name for last validator's event*
static final String	NODE_ATTENDEE_NAME	Name of the node for attendee *
static final String	NODE_ATTENDEES_NAME	Name of the node for attendees *
static final String	PROPERTY_ATTENDEE_EMAIL	Property name for attendee email *
static final String	PROPERTY_ATTENDEE_EXTERNAL	Property name for attendee external *
static final String	PROPERTY_ATTENDEE_LOGIN	Property name for attendee login *
static final String	PROPERTY_ATTENDEE_MANDATORY	Property name for attendee mandatory *
static final String	PROPERTY_ATTENDEE_POPULATION	Property name for attendee population *
static final String	PROPERTY_WORKFLOW_ID	Property's name for workflow id

Constructor Summary

Constructors

Constructor	Description
JCRCalendarEvent(Node node, String parentPath, JCRCalendarEventFactory factory)	Creates an JCRCalendarEvent.

Method Summary

Modifier and Type	Method	Description
List<CalendarEventAttendee>	getAttendees()	Get attendees to the event
Date	getCreationDate()	Retrieves the creation date.
UserIdentity	getCreator()	Retrieves the the creator.
long	getCurrentStepId()	Retrieves the current step id of the Ametys object
String	getDescription()	Get the description of the event
Date	getEndDate()	Get the date of the end of the event
List<Date>	getExcludedOccurences()	Retrieves the list of excluded event date.
Date	getFirstOccurrence(Date date)	Retrieves the start date of the first Event which end after the date
Boolean	getFullDay()	Get if the event last all the day
String[]	getKeywords()	Returns the keywords of this event, as a String array.
UserIdentity	getLastContributor()	Retrieves the last contributor.
Date	getLastModified()	Retrieves the last modification date.
Date	getLastValidated()	Retrieves the last validation date.
UserIdentity	getLastValidator()	Retrieves the last validator.
String	getLocation()	Get the location of the event
Date	getNextOccurrence(Date date)	Retrieves the date of the next event after the date
List<Date>	getOccurrences(Date startDate, Date endDate)	Retrieves the list of all event date between startDate and endDate.
UserIdentity	getOrganiser()	Retrieves the organiser.
EventRecurrenceTypeEnum	getRecurrenceType()	Retrieves the recurrence type.
Date	getRepeatUntil()	Retrieves the end date of the frequency.
Date	getStartDate()	Get the date of the begin of the event
String	getTitle()	Get the title of the event
long	getWorkflowId()	Retrieves the workflow id associated with the Ametys object.
Boolean	isRecurrent()	Retrieves if the event is recurrent.
void	setAttendees(List<CalendarEventAttendee> attendees)	Set attendees to the event
void	setCreationDate(Date date)	Set the creation date
void	setCreator(UserIdentity user)	Set the creator
void	setCurrentStepId(long stepId)	Set the current step id of the Ametys object
void	setDescription(String desc)	Set the description of the event
void	setEndDate(Date endDate)	Set the endDate of the event
void	setExcludedOccurrences(List<Date> excludedOccurrences)	Set the list of excluded event date.
void	setFullDay(Boolean fullDay)	Set if the event last all the day
void	setKeywords(String[] keywords)	Set this event's keywords.
void	setLastContributor(UserIdentity user)	Set the last contributor
void	setLastModified(Date date)	Set the last modified date
void	setLastValidated(Date date)	Set the last validation date of the event
void	setLastValidator(UserIdentity user)	Set the last validator of the event
void	setLocation(String location)	Set the location of the event
void	setOrganiser(UserIdentity user)	Set the oragniser
void	setRecurrenceType(String recurrenceType)	Set the recurrence type.
void	setRepeatUntil(Date untilDate)	Set the end date of the frequency.
void	setStartDate(Date startDate)	Set the startDate of the event
void	setTitle(String title)	Set the title of the event
void	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.

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.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Details

METADATA_CREATOR

public static final String METADATA_CREATOR

Metadata's name for author's event*

See Also:

• Constant Field Values

METADATA_CREATION

public static final String METADATA_CREATION

Metadata's name for lastModified's event*

See Also:

• Constant Field Values

METADATA_CONTRIBUTOR

public static final String METADATA_CONTRIBUTOR

Metadata's name for last contributor's event*

See Also:

• Constant Field Values

METADATA_MODIFIED

public static final String METADATA_MODIFIED

Metadata's name for lastModified's event*

See Also:

• Constant Field Values

METADATA_TITLE

public static final String METADATA_TITLE

Metadata's name for title's event*

See Also:

• Constant Field Values

METADATA_DESC

public static final String METADATA_DESC

Metadata's name for description's event*

See Also:

• Constant Field Values

METADATA_KEYWORDS

public static final String METADATA_KEYWORDS

Metadata's name for keywords' event*

See Also:

• Constant Field Values

METADATA_LOCATION

public static final String METADATA_LOCATION

Metadata's name for location's event*

See Also:

• Constant Field Values

METADATA_START_DATE

public static final String METADATA_START_DATE

Metadata's name for startDate's event*

See Also:

• Constant Field Values

METADATA_END_DATE

public static final String METADATA_END_DATE

Metadata's name for endDate's event*

See Also:

• Constant Field Values

METADATA_VALIDATED

public static final String METADATA_VALIDATED

Metadata's name for last validated date's event*

See Also:

• Constant Field Values

METADATA_VALIDATOR

public static final String METADATA_VALIDATOR

Metadata's name for last validator's event*

See Also:

• Constant Field Values

METADATA_FULL_DAY

public static final String METADATA_FULL_DAY

Metadata's name for fullDay's event*

See Also:

• Constant Field Values

METADATA_RECURRENCE_TYPE

public static final String METADATA_RECURRENCE_TYPE

Metadata's name for recurrence type event*

See Also:

• Constant Field Values

METADATA_UNTIL_DATE

public static final String METADATA_UNTIL_DATE

Metadata's name for until date event*

See Also:

• Constant Field Values

METADATA_EXCLUDED_DATE

public static final String METADATA_EXCLUDED_DATE

Metadata's name for excluded date event*

See Also:

• Constant Field Values

METADATA_ORGANISER

public static final String METADATA_ORGANISER

Metadata's name for organiser's event*

See Also:

• Constant Field Values

PROPERTY_ATTENDEE_POPULATION

public static final String PROPERTY_ATTENDEE_POPULATION

Property name for attendee population *

See Also:

• Constant Field Values

PROPERTY_ATTENDEE_LOGIN

public static final String PROPERTY_ATTENDEE_LOGIN

Property name for attendee login *

See Also:

• Constant Field Values

PROPERTY_ATTENDEE_EMAIL

public static final String PROPERTY_ATTENDEE_EMAIL

Property name for attendee email *

See Also:

• Constant Field Values

PROPERTY_ATTENDEE_EXTERNAL

public static final String PROPERTY_ATTENDEE_EXTERNAL

Property name for attendee external *

See Also:

• Constant Field Values

PROPERTY_ATTENDEE_MANDATORY

public static final String PROPERTY_ATTENDEE_MANDATORY

Property name for attendee mandatory *

See Also:

• Constant Field Values

NODE_ATTENDEES_NAME

public static final String NODE_ATTENDEES_NAME

Name of the node for attendees *

See Also:

• Constant Field Values

NODE_ATTENDEE_NAME

public static final String NODE_ATTENDEE_NAME

Name of the node for attendee *

See Also:

• Constant Field Values

PROPERTY_WORKFLOW_ID

public static final String PROPERTY_WORKFLOW_ID

Property's name for workflow id

See Also:

• Constant Field Values

Constructor Details

JCRCalendarEvent

public JCRCalendarEvent(Node node,
 String parentPath,
 JCRCalendarEventFactory factory)

Creates an JCRCalendarEvent.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

getTitle

public String getTitle()

Description copied from interface: CalendarEvent

Get the title of the event

Specified by:

getTitle in interface CalendarEvent

Returns:

the title of the event

getDescription

public String getDescription()

Description copied from interface: CalendarEvent

Get the description of the event

Specified by:

getDescription in interface CalendarEvent

Returns:

the description of the event

getLocation

public String getLocation()

Description copied from interface: CalendarEvent

Get the location of the event

Specified by:

getLocation in interface CalendarEvent

Returns:

the location of the event

getKeywords

public String[] getKeywords()
                     throws AmetysRepositoryException

Description copied from interface: CalendarEvent

Returns the keywords of this event, as a String array.

Specified by:

getKeywords in interface CalendarEvent

Returns:

the keywords of this event.

Throws:

AmetysRepositoryException - if an error occurs.

getStartDate

public Date getStartDate()

Description copied from interface: CalendarEvent

Get the date of the begin of the event

Specified by:

getStartDate in interface CalendarEvent

Returns:

the date of the event

getEndDate

public Date getEndDate()

Description copied from interface: CalendarEvent

Get the date of the end of the event

Specified by:

getEndDate in interface CalendarEvent

Returns:

the date of the event

getFullDay

public Boolean getFullDay()

Description copied from interface: CalendarEvent

Get if the event last all the day

Specified by:

getFullDay in interface CalendarEvent

Returns:

true if the event last all the day

getCreator

public UserIdentity getCreator()

Description copied from interface: CalendarEvent

Retrieves the the creator.

Specified by:

getCreator in interface CalendarEvent

Returns:

the creator.

getCreationDate

public Date getCreationDate()

Description copied from interface: CalendarEvent

Retrieves the creation date.

Specified by:

getCreationDate in interface CalendarEvent

Returns:

the creation date.

getLastContributor

public UserIdentity getLastContributor()

Description copied from interface: CalendarEvent

Retrieves the last contributor.

Specified by:

getLastContributor in interface CalendarEvent

Returns:

the last contributor.

getLastModified

public Date getLastModified()

Description copied from interface: CalendarEvent

Retrieves the last modification date.

Specified by:

getLastModified in interface CalendarEvent

Returns:

the last modification date.

getLastValidator

public UserIdentity getLastValidator()
                              throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: CalendarEvent

Retrieves the last validator.

Specified by:

getLastValidator in interface CalendarEvent

Returns:

the last validator.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getLastValidated

public Date getLastValidated()
                      throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: CalendarEvent

Retrieves the last validation date.

Specified by:

getLastValidated in interface CalendarEvent

Returns:

the last validation date.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

getRecurrenceType

public EventRecurrenceTypeEnum getRecurrenceType()

Description copied from interface: CalendarEvent

Retrieves the recurrence type.

Specified by:

getRecurrenceType in interface CalendarEvent

Returns:

the recurrence type.

isRecurrent

public Boolean isRecurrent()

Description copied from interface: CalendarEvent

Retrieves if the event is recurrent.

Specified by:

isRecurrent in interface CalendarEvent

Returns:

true if the event is recurrent.

getRepeatUntil

public Date getRepeatUntil()

Description copied from interface: CalendarEvent

Retrieves the end date of the frequency.

Specified by:

getRepeatUntil in interface CalendarEvent

Returns:

the end date of the frequency.

getExcludedOccurences

public List<Date> getExcludedOccurences()

Description copied from interface: CalendarEvent

Retrieves the list of excluded event date.

Specified by:

getExcludedOccurences in interface CalendarEvent

Returns:

the list of excluded event date.

getOrganiser

public UserIdentity getOrganiser()
                          throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: CalendarEvent

Retrieves the organiser.

Specified by:

getOrganiser in interface CalendarEvent

Returns:

the organiser.

Throws:

UnknownMetadataException - if this property does not exists.

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(String title)

Description copied from interface: ModifiableCalendarEvent

Set the title of the event

Specified by:

setTitle in interface ModifiableCalendarEvent

Parameters:

title - the title

setDescription

public void setDescription(String desc)

Description copied from interface: ModifiableCalendarEvent

Set the description of the event

Specified by:

setDescription in interface ModifiableCalendarEvent

Parameters:

desc - the description

setLocation

public void setLocation(String location)

Description copied from interface: ModifiableCalendarEvent

Set the location of the event

Specified by:

setLocation in interface ModifiableCalendarEvent

Parameters:

location - the location

setKeywords

public void setKeywords(String[] keywords)

Description copied from interface: ModifiableCalendarEvent

Set this event's keywords.

Specified by:

setKeywords in interface ModifiableCalendarEvent

Parameters:

keywords - the keywords.

setStartDate

public void setStartDate(Date startDate)

Description copied from interface: ModifiableCalendarEvent

Set the startDate of the event

Specified by:

setStartDate in interface ModifiableCalendarEvent

Parameters:

startDate - the start date

setEndDate

public void setEndDate(Date endDate)

Description copied from interface: ModifiableCalendarEvent

Set the endDate of the event

Specified by:

setEndDate in interface ModifiableCalendarEvent

Parameters:

endDate - the end date

setFullDay

public void setFullDay(Boolean fullDay)

Description copied from interface: ModifiableCalendarEvent

Set if the event last all the day

Specified by:

setFullDay in interface ModifiableCalendarEvent

Parameters:

fullDay - is a fullday event

setCreator

public void setCreator(UserIdentity user)
                throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the creator

Specified by:

setCreator in interface ModifiableCalendarEvent

Parameters:

user - The creator

Throws:

UnknownMetadataException

AmetysRepositoryException

setCreationDate

public void setCreationDate(Date date)
                     throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the creation date

Specified by:

setCreationDate in interface ModifiableCalendarEvent

Parameters:

date - The creation date

Throws:

UnknownMetadataException

AmetysRepositoryException

setLastContributor

public void setLastContributor(UserIdentity user)
                        throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the last contributor

Specified by:

setLastContributor in interface ModifiableCalendarEvent

Parameters:

user - The last contributor

Throws:

UnknownMetadataException

AmetysRepositoryException

setLastModified

public void setLastModified(Date date)
                     throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the last modified date

Specified by:

setLastModified in interface ModifiableCalendarEvent

Parameters:

date - The last modified date

Throws:

UnknownMetadataException

AmetysRepositoryException

setLastValidator

public void setLastValidator(UserIdentity user)
                      throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the last validator of the event

Specified by:

setLastValidator in interface ModifiableCalendarEvent

Parameters:

user - the last validator of the event

Throws:

UnknownMetadataException

AmetysRepositoryException

setLastValidated

public void setLastValidated(Date date)
                      throws UnknownMetadataException,
AmetysRepositoryException

Description copied from interface: ModifiableCalendarEvent

Set the last validation date of the event

Specified by:

setLastValidated in interface ModifiableCalendarEvent

Parameters:

date - the last validation date of the event

Throws:

UnknownMetadataException

AmetysRepositoryException

setRecurrenceType

public void setRecurrenceType(String recurrenceType)

Description copied from interface: ModifiableCalendarEvent

Set the recurrence type.

Specified by:

setRecurrenceType in interface ModifiableCalendarEvent

Parameters:

recurrenceType - the recurrence type

setRepeatUntil

public void setRepeatUntil(Date untilDate)

Description copied from interface: ModifiableCalendarEvent

Set the end date of the frequency.

Specified by:

setRepeatUntil in interface ModifiableCalendarEvent

Parameters:

untilDate - the end date of the recurrence

setExcludedOccurrences

public void setExcludedOccurrences(List<Date> excludedOccurrences)

Description copied from interface: ModifiableCalendarEvent

Set the list of excluded event date.

Specified by:

setExcludedOccurrences in interface ModifiableCalendarEvent

Parameters:

excludedOccurrences - excluded date

getOccurrences

public List<Date> getOccurrences(Date startDate,
 Date endDate)

Description copied from interface: CalendarEvent

Retrieves the list of all event date between startDate and endDate.

Specified by:

getOccurrences in interface CalendarEvent

Parameters:

startDate - the start date

endDate - the end date

Returns:

the list of all event date between startDate and endDate.

getFirstOccurrence

public Date getFirstOccurrence(Date date)

Description copied from interface: CalendarEvent

Retrieves the start date of the first Event which end after the date

Specified by:

getFirstOccurrence in interface CalendarEvent

Parameters:

date - the date

Returns:

the start date of the first Event which end after the date

getNextOccurrence

public Date getNextOccurrence(Date date)

Description copied from interface: CalendarEvent

Retrieves the date of the next event after the date

Specified by:

getNextOccurrence in interface CalendarEvent

Parameters:

date - the date

Returns:

the date of the next event after the date

getWorkflowId

public long getWorkflowId()
                   throws AmetysRepositoryException

Description copied from interface: WorkflowAwareAmetysObject

Retrieves the workflow id associated with the Ametys object.

Specified by:

getWorkflowId in interface WorkflowAwareAmetysObject

Returns:

the workflow id.

Throws:

AmetysRepositoryException - if an error occurs.

setWorkflowId

public void setWorkflowId(long workflowId)
                   throws AmetysRepositoryException

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 interface WorkflowAwareAmetysObject

Parameters:

workflowId - the workflow id of the object.

Throws:

AmetysRepositoryException - if an error occurs.

getCurrentStepId

public long getCurrentStepId()

Description copied from interface: WorkflowAwareAmetysObject

Retrieves the current step id of the Ametys object

Specified by:

getCurrentStepId in interface WorkflowAwareAmetysObject

Returns:

the current step id

setCurrentStepId

public void setCurrentStepId(long stepId)

Description copied from interface: WorkflowAwareAmetysObject

Set the current step id of the Ametys object

Specified by:

setCurrentStepId in interface WorkflowAwareAmetysObject

Parameters:

stepId - the step id to set

setOrganiser

public void setOrganiser(UserIdentity user)

Description copied from interface: ModifiableCalendarEvent

Set the oragniser

Specified by:

setOrganiser in interface ModifiableCalendarEvent

Parameters:

user - The oragniser

getAttendees

public List<CalendarEventAttendee> getAttendees()
                                         throws RepositoryException

Get attendees to the event

Returns:

the attendees

Throws:

RepositoryException - if an error occurred

setAttendees

public void setAttendees(List<CalendarEventAttendee> attendees)
                  throws RepositoryException

Set attendees to the event

Parameters:

attendees - the list of attendees

Throws:

RepositoryException - if an error occurred