Package org.silverpeas.core.webapi.calendar

Class CalendarEventOccurrenceEntity

java.lang.Object

org.silverpeas.core.webapi.calendar.CalendarEventEntity

org.silverpeas.core.webapi.calendar.CalendarEventOccurrenceEntity

All Implemented Interfaces:

Serializable, WebEntity

Direct Known Subclasses:

CalendarEventOccurrenceDeleteEntity, CalendarEventOccurrenceUpdateEntity

public class CalendarEventOccurrenceEntity
extends CalendarEventEntity

It represents the state of a calendar event in a calendar as transmitted within the body of an HTTP response or an HTTP request.

Author:

Yohann Chastagnier

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CalendarEventOccurrenceEntity()

Method Summary

Modifier and Type	Method	Description
static String	decodeId(String occurrenceId)
protected CalendarEventOccurrenceEntity	decorate(CalendarEventOccurrence calendarEventOccurrence, String componentInstanceId, ZoneId zoneId, boolean isEditionMode)
boolean	equals(Object o)
static CalendarEventOccurrenceEntity	fromOccurrence(CalendarEventOccurrence occurrence, String componentInstanceId, ZoneId zoneId, boolean isEditionMode)
URI	getOccurrenceEditionUrl()
String	getOccurrenceId()
URI	getOccurrencePermalinkUrl()
URI	getOccurrenceUri()
URI	getOccurrenceViewUrl()
String	getOriginalStartDate()
URI	getURI()	Gets the URI at which this web entity is published and can be accessed.
int	hashCode()
boolean	isFirstEventOccurrence()
protected void	setFirstEventOccurrence(boolean firstEventOccurrence)
void	setOccurrenceEditionUrl(URI occurrenceEditionUrl)
void	setOccurrenceId(String occurrenceId)
void	setOccurrencePermalinkUrl(URI occurrencePermalinkUrl)
protected void	setOccurrenceUri(URI occurrenceUri)
void	setOccurrenceViewUrl(URI occurrenceViewUrl)
void	setOriginalStartDate(String originalStartDate)
protected org.apache.commons.lang3.builder.ToStringBuilder	toStringBuilder()
CalendarEventOccurrenceEntity	withAttendees(List<CalendarEventAttendeeEntity> attendees)	Sets attendees to the occurrence entity.
CalendarEventOccurrenceEntity	withAttributes(List<CalendarEventAttributeEntity> attributes)	Sets attributes to the occurrence entity.
CalendarEventOccurrenceEntity	withCalendarURI(URI calendarUri)	Sets a URI to linked calendar entity.
CalendarEventOccurrenceEntity	withEventPermalinkURL(URI permalinkUrl)	Sets a URI to this entity.
CalendarEventOccurrenceEntity	withEventURI(URI eventUri)	Sets a URI to this entity.
CalendarEventOccurrenceEntity	withOccurrenceEditionURL(URI occurrenceEditionUrl)	Sets a URI of the edition page of the occurrence.
CalendarEventOccurrenceEntity	withOccurrencePermalinkURL(URI permalinkUrl)	Sets a permalink URI to this entity.
CalendarEventOccurrenceEntity	withOccurrenceURI(URI occurrenceUri)	Sets a URI of occurrence entity.
CalendarEventOccurrenceEntity	withOccurrenceViewURL(URI occurrenceViewUrl)	Sets a URI of the view page of the occurrence.

Methods inherited from class org.silverpeas.core.webapi.calendar.CalendarEventEntity

calendarSync, canBeAccessed, canBeDeleted, canBeModified, decorate, fromEvent, getAttachmentParameters, getAttendees, getAttributes, getCalendarId, getCalendarUri, getCalendarZoneId, getContent, getContributionType, getCreateDate, getCreatedById, getDescription, getEndDate, getEventId, getEventPermalinkUrl, getEventUri, getId, getLastUpdateDate, getLastUpdatedById, getLocation, getOwnerName, getPdcClassification, getPriority, getRecurrence, getReminder, getStartDate, getTitle, getVisibility, isOnAllDay, setAttendees, setAttributes, setCalendarId, setCalendarUri, setCalendarZoneId, setContent, setContributionType, setDescription, setEndDate, setEventId, setEventPermalinkUrl, setEventUri, setId, setLastUpdateDate, setLastUpdatedById, setLocation, setOnAllDay, setPriority, setRecurrence, setStartDate, setTitle, setURI, setVisibility, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarEventOccurrenceEntity

protected CalendarEventOccurrenceEntity()

Method Detail

fromOccurrence

public static CalendarEventOccurrenceEntity fromOccurrence(CalendarEventOccurrence occurrence,
                                                           String componentInstanceId,
                                                           ZoneId zoneId,
                                                           boolean isEditionMode)

decodeId

public static String decodeId(String occurrenceId)

withOccurrenceViewURL

public CalendarEventOccurrenceEntity withOccurrenceViewURL(URI occurrenceViewUrl)

Sets a URI of the view page of the occurrence.

Parameters:

occurrenceViewUrl - the occurrence web entity URI.

Returns:

itself.

withOccurrenceEditionURL

public CalendarEventOccurrenceEntity withOccurrenceEditionURL(URI occurrenceEditionUrl)

Sets a URI of the edition page of the occurrence.

Parameters:

occurrenceEditionUrl - the occurrence web entity URI.

Returns:

itself.

withOccurrencePermalinkURL

public CalendarEventOccurrenceEntity withOccurrencePermalinkURL(URI permalinkUrl)

Sets a permalink URI to this entity. With this URI, it can then be accessed through the Web.

Parameters:

permalinkUrl - the web entity URI.

Returns:

itself.

withOccurrenceURI

public CalendarEventOccurrenceEntity withOccurrenceURI(URI occurrenceUri)

Sets a URI of occurrence entity. With this URI, it can then be accessed through the Web.

Parameters:

occurrenceUri - the occurrence web entity URI.

Returns:

itself.

withEventURI

public CalendarEventOccurrenceEntity withEventURI(URI eventUri)

Description copied from class: CalendarEventEntity

Sets a URI to this entity. With this URI, it can then be accessed through the Web.

Overrides:

withEventURI in class CalendarEventEntity

Parameters:

eventUri - the web entity URI.

Returns:

itself.

withCalendarURI

public CalendarEventOccurrenceEntity withCalendarURI(URI calendarUri)

Description copied from class: CalendarEventEntity

Sets a URI to linked calendar entity. With this URI, it can then be accessed through the Web.

Overrides:

withCalendarURI in class CalendarEventEntity

Parameters:

calendarUri - the linked calendar web entity URI.

Returns:

itself.

withEventPermalinkURL

public CalendarEventOccurrenceEntity withEventPermalinkURL(URI permalinkUrl)

Description copied from class: CalendarEventEntity

Sets a URI to this entity. With this URI, it can then be accessed through the Web.

Overrides:

withEventPermalinkURL in class CalendarEventEntity

Parameters:

permalinkUrl - the web entity URI.

Returns:

itself.

withAttendees

public CalendarEventOccurrenceEntity withAttendees(List<CalendarEventAttendeeEntity> attendees)

Sets attendees to the occurrence entity.

Overrides:

withAttendees in class CalendarEventEntity

Parameters:

attendees - the attendees to set.

Returns:

itself.

withAttributes

public CalendarEventOccurrenceEntity withAttributes(List<CalendarEventAttributeEntity> attributes)

Sets attributes to the occurrence entity.

Overrides:

withAttributes in class CalendarEventEntity

Parameters:

attributes - the attributes to set.

Returns:

itself.

getURI

public URI getURI()

Description copied from interface: WebEntity

Gets the URI at which this web entity is published and can be accessed.

Specified by:

getURI in interface WebEntity

Overrides:

getURI in class CalendarEventEntity

Returns:

the web entity URI.

getOccurrenceUri

public URI getOccurrenceUri()

setOccurrenceUri

protected void setOccurrenceUri(URI occurrenceUri)

getOccurrenceViewUrl

public URI getOccurrenceViewUrl()

setOccurrenceViewUrl

public void setOccurrenceViewUrl(URI occurrenceViewUrl)

getOccurrenceEditionUrl

public URI getOccurrenceEditionUrl()

setOccurrenceEditionUrl

public void setOccurrenceEditionUrl(URI occurrenceEditionUrl)

getOccurrencePermalinkUrl

public URI getOccurrencePermalinkUrl()

setOccurrencePermalinkUrl

public void setOccurrencePermalinkUrl(URI occurrencePermalinkUrl)

getOccurrenceId

public String getOccurrenceId()

setOccurrenceId

public void setOccurrenceId(String occurrenceId)

getOriginalStartDate

public String getOriginalStartDate()

setOriginalStartDate

public void setOriginalStartDate(String originalStartDate)

isFirstEventOccurrence

public boolean isFirstEventOccurrence()

setFirstEventOccurrence

protected void setFirstEventOccurrence(boolean firstEventOccurrence)

decorate

protected CalendarEventOccurrenceEntity decorate(CalendarEventOccurrence calendarEventOccurrence,
                                                 String componentInstanceId,
                                                 ZoneId zoneId,
                                                 boolean isEditionMode)

toStringBuilder

protected org.apache.commons.lang3.builder.ToStringBuilder toStringBuilder()

Overrides:

toStringBuilder in class CalendarEventEntity

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object