Package org.ametys.plugins.workspaces.calendars.task

Class TaskCalendar

java.lang.Object

org.ametys.plugins.workspaces.calendars.task.TaskCalendar

All Implemented Interfaces:

Calendar, ModifiableCalendar

public class TaskCalendar
extends Object
implements ModifiableCalendar

Task calendar object

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.workspaces.calendars.Calendar

Calendar.CalendarVisibility

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TASK_CALENDAR_COLOR_ATTR	The attribute name for the task calendar color
static final String	TASK_CALENDAR_DISABLED_ATTR	The attribute name to detect is the task calendar is disabled
static final String	TASK_CALENDAR_NAME_ATTR	The attribute name for the task calendar name
static final String	TASK_CALENDAR_TOKEN_ATTR	The attribute name for the task calendar token
static final String	TASK_CALENDAR_VISIBILITY_ATTR	The attribute name for the task calendar visibility

Constructor Summary

Constructors

Constructor	Description
TaskCalendar(Project project, JCRResourcesCollection calendarModuleRoot, WorkspaceTaskDAO taskDAO)	The constructor

Method Summary

Modifier and Type	Method	Description
void	disable(boolean disabled)	Disable the task calendar
List<CalendarEvent>	getAllEvents()	Get all events of the calendar
List<Calendar>	getChildCalendars()	Get the child calendars
String	getColor()	Get the color of the calendar
String	getDescription()	Get the description of the calendar
Map<CalendarEvent,List<CalendarEventOccurrence>>	getEvents(ZonedDateTime startDate, ZonedDateTime endDate)	Get the events and its occurrences of the calendar between two dates
String	getIcsUrlToken()	Get the token used by the ICS public URL
String	getId()	Get the id of the calendar
String	getName()	Get the name of the calendar
Project	getProject()	Get the project
String	getTemplateDescription()	Get the template description of the calendar
Calendar.CalendarVisibility	getVisibility()	Get the calendar visibility
boolean	isDisabled()	true if the calendar is disabled
void	rename(String name)	Set the calendar name
void	setColor(String color)	set the color of the calendar
void	setDescription(String desc)	set the description of the calendar
void	setIcsUrlToken(String token)	Set the token used by the ICS public URL
void	setTemplateDescription(String templateDesc)	set the template description of the calendar
void	setVisibility(Calendar.CalendarVisibility visibility)	Set the visibility of the calendar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TASK_CALENDAR_DISABLED_ATTR

public static final String TASK_CALENDAR_DISABLED_ATTR

The attribute name to detect is the task calendar is disabled

See Also:

• Constant Field Values

TASK_CALENDAR_NAME_ATTR

public static final String TASK_CALENDAR_NAME_ATTR

The attribute name for the task calendar name

See Also:

• Constant Field Values

TASK_CALENDAR_TOKEN_ATTR

public static final String TASK_CALENDAR_TOKEN_ATTR

The attribute name for the task calendar token

See Also:

• Constant Field Values

TASK_CALENDAR_VISIBILITY_ATTR

public static final String TASK_CALENDAR_VISIBILITY_ATTR

The attribute name for the task calendar visibility

See Also:

• Constant Field Values

TASK_CALENDAR_COLOR_ATTR

public static final String TASK_CALENDAR_COLOR_ATTR

The attribute name for the task calendar color

See Also:

• Constant Field Values

Constructor Details

TaskCalendar

public TaskCalendar(Project project,
 JCRResourcesCollection calendarModuleRoot,
 WorkspaceTaskDAO taskDAO)

The constructor

Parameters:

project - the project

calendarModuleRoot - the calendar module root

taskDAO - the task DAO

Method Details

isDisabled

public boolean isDisabled()

true if the calendar is disabled

Returns:

true if the calendar is disabled

disable

public void disable(boolean disabled)

Disable the task calendar

Parameters:

disabled - true to disable the task calendar

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: Calendar

Get the id of the calendar

Specified by:

getId in interface Calendar

Returns:

the id

Throws:

AmetysRepositoryException

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: Calendar

Get the name of the calendar

Specified by:

getName in interface Calendar

Returns:

the name

Throws:

AmetysRepositoryException

rename

public void rename(String name)

Description copied from interface: ModifiableCalendar

Set the calendar name

Specified by:

rename in interface ModifiableCalendar

Parameters:

name - The name

getProject

public Project getProject()

Description copied from interface: Calendar

Get the project

Specified by:

getProject in interface Calendar

Returns:

the project

getColor

public String getColor()

Description copied from interface: Calendar

Get the color of the calendar

Specified by:

getColor in interface Calendar

Returns:

the color of the calendar

setColor

public void setColor(String color)

Description copied from interface: ModifiableCalendar

set the color of the calendar

Specified by:

setColor in interface ModifiableCalendar

Parameters:

color - The color to set

getVisibility

public Calendar.CalendarVisibility getVisibility()

Description copied from interface: Calendar

Get the calendar visibility

Specified by:

getVisibility in interface Calendar

Returns:

the calendar visibility

setVisibility

public void setVisibility(Calendar.CalendarVisibility visibility)

Description copied from interface: ModifiableCalendar

Set the visibility of the calendar

Specified by:

setVisibility in interface ModifiableCalendar

Parameters:

visibility - The visibility

getIcsUrlToken

public String getIcsUrlToken()

Description copied from interface: Calendar

Get the token used by the ICS public URL

Specified by:

getIcsUrlToken in interface Calendar

Returns:

The token, or null if no token exists for the calendar

setIcsUrlToken

public void setIcsUrlToken(String token)

Description copied from interface: ModifiableCalendar

Set the token used by the ICS public URL

Specified by:

setIcsUrlToken in interface ModifiableCalendar

Parameters:

token - The token, or null to delete the existing token

getDescription

public String getDescription()

Description copied from interface: Calendar

Get the description of the calendar

Specified by:

getDescription in interface Calendar

Returns:

the description

setDescription

public void setDescription(String desc)

Description copied from interface: ModifiableCalendar

set the description of the calendar

Specified by:

setDescription in interface ModifiableCalendar

Parameters:

desc - The description

getTemplateDescription

public String getTemplateDescription()

Description copied from interface: Calendar

Get the template description of the calendar

Specified by:

getTemplateDescription in interface Calendar

Returns:

the template description of the calendar

setTemplateDescription

public void setTemplateDescription(String templateDesc)

Description copied from interface: ModifiableCalendar

set the template description of the calendar

Specified by:

setTemplateDescription in interface ModifiableCalendar

Parameters:

templateDesc - The template description

getChildCalendars

public List<Calendar> getChildCalendars()

Description copied from interface: Calendar

Get the child calendars

Specified by:

getChildCalendars in interface Calendar

Returns:

the child calendars

getAllEvents

public List<CalendarEvent> getAllEvents()

Description copied from interface: Calendar

Get all events of the calendar

Specified by:

getAllEvents in interface Calendar

Returns:

the list of events

getEvents

public Map<CalendarEvent,List<CalendarEventOccurrence>> getEvents(ZonedDateTime startDate,
 ZonedDateTime endDate)

Description copied from interface: Calendar

Get the events and its occurrences of the calendar between two dates

Specified by:

getEvents in interface Calendar

Parameters:

startDate - Begin date

endDate - End date

Returns:

the map of events and its occurrences