PredefinedCalendarDefinition.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jasig.portlet.calendar;

import java.util.HashSet;
import java.util.Set;

/**
 * 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
 */
public class PredefinedCalendarDefinition extends CalendarDefinition {

  private String fname;
  private Set<PredefinedCalendarConfiguration> userConfigurations =
      new HashSet<PredefinedCalendarConfiguration>();
  private Set<String> defaultRoles;

  /** Default constructor */
  public PredefinedCalendarDefinition() {
    super();
  }

  /**
   * Construct a new predefined calendar definition
   *
   * @param id
   * @param className
   * @param name
   */
  public PredefinedCalendarDefinition(Long id, String className, String name) {
    super(id, className, name);
  }

  /**
   * Get all the user configurations for this calendar definition
   *
   * @return
   */
  public Set<PredefinedCalendarConfiguration> getUserConfigurations() {
    return userConfigurations;
  }

  /**
   * Set the user configurations for this calendar definition
   *
   * @param configurations
   */
  public void setUserConfigurations(Set<PredefinedCalendarConfiguration> configurations) {
    this.userConfigurations = configurations;
  }

  /**
   * Get the set of user roles who should get this calendar by default.
   *
   * @return set of default user roles
   */
  public Set<String> getDefaultRoles() {
    return defaultRoles;
  }

  /**
   * Set the user roles should should get this calendar by default.
   *
   * @param defaultRoles set of default user roles
   */
  public void setDefaultRoles(Set<String> defaultRoles) {
    this.defaultRoles = defaultRoles;
  }

  /**
   * Add a user configuration for this calendar definition
   *
   * @param config
   */
  public void addUserConfiguration(PredefinedCalendarConfiguration config) {
    this.userConfigurations.add(config);
  }

  /**
   * Add a user role to the set of roles that should get this calendar by default.
   *
   * @param role user role to be added
   */
  public void addDefaultRole(String role) {
    this.defaultRoles.add(role);
  }

  public String getFname() {
    return fname;
  }

  public void setFname(String fname) {
    this.fname = fname;
  }
}