org.jasig.portlet.calendar
Class PredefinedCalendarDefinition

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

public class PredefinedCalendarDefinition
extends CalendarDefinition

PredefinedCalendarDefinition represents a built-in calendar definition. These definitions are defined in the database by an administrator, and can be automatically added to user's calendar registration lists based on user role.

Author:

Jen Bourey

Constructor Summary

PredefinedCalendarDefinition()
Default constructor

PredefinedCalendarDefinition(Long id, String className, String name)
Construct a new predefined calendar definition

Method Summary

void	addDefaultRole(String role) Add a user role to the set of roles that should get this calendar by default.
void	addUserConfiguration(PredefinedCalendarConfiguration config) Add a user configuration for this calendar definition
Set<String>	getDefaultRoles() Get the set of user roles who should get this calendar by default.
String	getFname()
Set<PredefinedCalendarConfiguration>	getUserConfigurations() Get all the user configurations for this calendar definition
void	setDefaultRoles(Set<String> defaultRoles) Set the user roles should should get this calendar by default.
void	setFname(String fname)
void	setUserConfigurations(Set<PredefinedCalendarConfiguration> configurations) Set the user configurations for this calendar definition

Methods inherited from class org.jasig.portlet.calendar.CalendarDefinition

addParameter, getClassName, getId, getName, getParameters, setClassName, setId, setName, setParameters, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PredefinedCalendarDefinition

public PredefinedCalendarDefinition()

Default constructor

PredefinedCalendarDefinition

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

Construct a new predefined calendar definition

Parameters:

id -

className -

name -

Method Detail

getUserConfigurations

public Set<PredefinedCalendarConfiguration> getUserConfigurations()

Get all the user configurations for this calendar definition

Returns:

setUserConfigurations

public void setUserConfigurations(Set<PredefinedCalendarConfiguration> configurations)

Set the user configurations for this calendar definition

Parameters:

configurations -

getDefaultRoles

public Set<String> getDefaultRoles()

Get the set of user roles who should get this calendar by default.

Returns:

set of default user roles

setDefaultRoles

public void setDefaultRoles(Set<String> defaultRoles)

Set the user roles should should get this calendar by default.

Parameters:

defaultRoles - set of default user roles

addUserConfiguration

public void addUserConfiguration(PredefinedCalendarConfiguration config)

Add a user configuration for this calendar definition

Parameters:

config -

addDefaultRole

public void addDefaultRole(String role)

Add a user role to the set of roles that should get this calendar by default.

Parameters:

role - user role to be added

getFname

public String getFname()

setFname

public void setFname(String fname)