org.jasig.portlet.calendar
Class CalendarDefinition

java.lang.Object
  org.jasig.portlet.calendar.CalendarDefinition

Direct Known Subclasses:

PredefinedCalendarDefinition, UserDefinedCalendarDefinition

public class CalendarDefinition
extends Object

CalendarDefinition represents the base class for calendar registrations. Information required to retrieve the calendar, such as the calendar's URL or important default system-wide configuration information may be stored in the parameters map. In order to add this calendar for a specific user, a CalendarConfiguration referencing this calendar definition must be created.

Author:

Jen Bourey

Constructor Summary

CalendarDefinition()
Default constructor.

CalendarDefinition(Long id, String className, String name)

Method Summary

void	addParameter(String name, String value) Add an individual calendar parameter.
String	getClassName() Returns the name of the adapter class for this calendar which will determine how the calendar is retrieved.
Long	getId() Return the unique id of this calendar.
String	getName() Return the display name for this calendar.
Map<String,String>	getParameters() Return the map of calendar parameters.
void	setClassName(String className) Set the name of the adapter class for this calendar which will determine how the calendar is retrieved.
void	setId(Long id) Set the unique id for this calendar.
void	setName(String name) Set the display name for this calendar.
void	setParameters(Map<String,String> parameters) Set the map of calendar parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarDefinition

public CalendarDefinition()

Default constructor.

CalendarDefinition

public CalendarDefinition(Long id,
                          String className,
                          String name)

Method Detail

getId

public Long getId()

Return the unique id of this calendar.

Returns:

setId

public void setId(Long id)

Set the unique id for this calendar.

Parameters:

id -

getClassName

public String getClassName()

Returns the name of the adapter class for this calendar which will determine how the calendar is retrieved. This id must match a calendar adapter registered in the spring context files.

Returns:

setClassName

public void setClassName(String className)

Set the name of the adapter class for this calendar which will determine how the calendar is retrieved. This id must match a calendar adapter registered in the spring context files.

Parameters:

className -

getName

public String getName()

Return the display name for this calendar.

Returns:

setName

public void setName(String name)

Set the display name for this calendar.

Parameters:

name -

getParameters

public Map<String,String> getParameters()

Return the map of calendar parameters. These parameters can hold any extra information needed by the particular adapter used by this calendar, such as a URL.

Returns:

parameter map

setParameters

public void setParameters(Map<String,String> parameters)

Set the map of calendar parameters. These parameters can hold any extra information needed by the particular adapter used by this calendar, such as a URL.

Parameters:

parameters - parameter map

addParameter

public void addParameter(String name,
                         String value)

Add an individual calendar parameter. These parameters can hold any extra information needed by the particular adapter used by this calendar, such as a URL.

Parameters:

name - parameter name (key)

value - value to be stored

toString

public String toString()

Overrides:

toString in class Object