org.bedework.calfacade.CollectionAliases Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bw-calendar-facade Show documentation

Common calendar classes and code for bedework

The newest version!

/* ********************************************************************
    Licensed to Jasig under one or more contributor license
    agreements. See the NOTICE file distributed with this work
    for additional information regarding copyright ownership.
    Jasig 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:

    http://www.apache.org/licenses/LICENSE-2.0

    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.bedework.calfacade;

import java.io.Serializable;
import java.util.List;

/** Provide information about the aliases for the given collection.
 *
 * If the collection is an alias and the aliased list is empty, or
 * the last element in the aliased list is an alias then the target
 * of that alias is inaccessible or missing. getInvalidAlias() will
 * return the collection in error.
 *
 * @author Mike Douglass
 */
public interface CollectionAliases extends Serializable {
  /**
   * @return collection that was queried.
   */
  BwCalendar getCollection();

  /**
   * @return chain of aliases closest to collection first.
   *         Empty for none.
   */
  List getAliased();

  /**
   * @return true if a circular reference is detected
   */
  public BwCalendar getInvalidAlias();

  /**
   * @return true if a circular reference is detected
   */
  public boolean getCircular();
}