java.lang.Object
- org.silverpeas.core.webapi.calendar.CalendarEntity

All Implemented Interfaces:

Serializable, WebEntity
```
public class CalendarEntity
extends Object
implements WebEntity
```
It represents the state of a calendar 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 CalendarEntity()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canBeDeleted()`
`boolean`	`canBeModified()`
`protected <T extends CalendarEntity> T`	`decorate(Calendar calendar)`
`static CalendarEntity`	`fromCalendar(Calendar calendar)`
`Date`	`getCreateDate()`
`URI`	`getExternalUrl()`
`String`	`getId()`
`Date`	`getLastUpdateDate()`
`String`	`getOwnerName()`
`String`	`getTitle()`
`URI`	`getURI()`	Gets the URI at which this web entity is published and can be accessed.
`String`	`getZoneId()`
`boolean`	`isMain()`
`boolean`	`isUserMainPersonal()`
`boolean`	`isUserPersonal()`
`Calendar`	`merge(Calendar calendar)`	Merges into given calendar instance the data from the entity. System data are not merged (id, creation date, update date, ...)
`void`	`setExternalUrl(URI externalUrl)`
`void`	`setId(String id)`
`protected void`	`setTitle(String title)`
`protected void`	`setUri(URI uri)`
`void`	`setZoneId(String zoneId)`
`String`	`toString()`
`CalendarEntity`	`withICalPrivateURI(URI uri)`	Sets a ical public URI to this entity.
`CalendarEntity`	`withICalPublicURI(URI uri)`	Sets a ical public URI to this entity.
`CalendarEntity`	`withURI(URI uri)`	Sets a URI to this entity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CalendarEntity
```
protected CalendarEntity()
```
- Method Detail
  - fromCalendar
```
public static CalendarEntity fromCalendar(Calendar calendar)
```
  - withURI
```
public CalendarEntity withURI(URI uri)
```
    Sets a URI to this entity. With this URI, it can then be accessed through the Web.
    
    Parameters:
    
    uri - the web entity URI.
    
    Returns:
    
    itself.
  - withICalPublicURI
```
public CalendarEntity withICalPublicURI(URI uri)
```
    Sets a ical public URI to this entity.
    
    Parameters:
    
    uri - the web entity URI.
    
    Returns:
    
    itself.
  - withICalPrivateURI
```
public CalendarEntity withICalPrivateURI(URI uri)
```
    Sets a ical public URI to this entity.
    
    Parameters:
    
    uri - the web entity URI.
    
    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
    
    Returns:
    
    the web entity URI.
  - setUri
```
protected void setUri(URI uri)
```
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
protected void setTitle(String title)
```
  - getZoneId
```
public String getZoneId()
```
  - setZoneId
```
public void setZoneId(String zoneId)
```
  - getExternalUrl
```
public URI getExternalUrl()
```
  - setExternalUrl
```
public void setExternalUrl(URI externalUrl)
```
  - isMain
```
public boolean isMain()
```
  - isUserMainPersonal
```
public boolean isUserMainPersonal()
```
  - isUserPersonal
```
public boolean isUserPersonal()
```
  - getOwnerName
```
public String getOwnerName()
```
  - getCreateDate
```
public Date getCreateDate()
```
  - getLastUpdateDate
```
public Date getLastUpdateDate()
```
  - canBeModified
```
public boolean canBeModified()
```
  - canBeDeleted
```
public boolean canBeDeleted()
```
  - decorate
```
protected <T extends CalendarEntity> T decorate(Calendar calendar)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - merge
```
public Calendar merge(Calendar calendar)
```
    Merges into given calendar instance the data from the entity.
    System data are not merged (id, creation date, update date, ...)
    
    Parameters:
    
    calendar - the calendar which will get the new data.
    
    Returns:
    
    the given calendar instance with merged data.

Class CalendarEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CalendarEntity

Method Detail

fromCalendar

withURI

withICalPublicURI

withICalPrivateURI

getURI

setUri

getId

setId

getTitle

setTitle

getZoneId

setZoneId

getExternalUrl

setExternalUrl

isMain

isUserMainPersonal

isUserPersonal

getOwnerName

getCreateDate

getLastUpdateDate

canBeModified

canBeDeleted

decorate

toString

merge