org.apache.myfaces.custom.schedule.model.ScheduleModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tomahawk12 Show documentation

JSF components and utilities that can be used with any JSF implementation. This library is based on the JSF1.1 version of Tomahawk, but with minor source code and build changes to take advantage of JSF1.2 features. A JSF1.2 implementation is required to use this version of the Tomahawk library.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.myfaces.custom.schedule.model;

import java.util.Date;
import java.util.Iterator;
import java.util.TimeZone;


/**
 * 
 * The underlying model of the UISchedule component. You should implement this
 * interface when creating real implementations, which would typically be backed
 * by a database.
 * 
 *
 * @author Jurgen Lust (latest modification by $Author: schof $)
 * @version $Revision: 368941 $
 */
public interface ScheduleModel
{
    //~ Static fields/initializers ---------------------------------------------

    public static final int DAY = 0;
    public static final int WORKWEEK = 1;
    public static final int WEEK = 2;
    public static final int MONTH = 3;

    //~ Methods ----------------------------------------------------------------

    /**
     * @return true if there are no entries
     */
    public abstract boolean isEmpty();

    /**
     * @param mode the mode: DAY, WORKWEEK, WEEK or MONTH
     */
    public abstract void setMode(int mode);

    /**
     * @return the mode: DAY, WORKWEEK, WEEK or MONTH
     */
    public abstract int getMode();

    /**
     * @param date the date to select
     */
    public abstract void setSelectedDate(Date date);

    /**
     * @return the selected date
     */
    public abstract Date getSelectedDate();

    /**
     * @param selectedEntry the entry to select
     */
    public abstract void setSelectedEntry(ScheduleEntry selectedEntry);

    /**
     * @return the selected entry
     */
    public abstract ScheduleEntry getSelectedEntry();
    
    /**
     * @return whether an entry is currently selected
     */
    public abstract boolean isEntrySelected();

    /**
     * 
     * Check if the schedule contains the specified date
     * 
     *
     * @param date the date to check
     *
     * @return whether the schedule containts this date
     */
    public abstract boolean containsDate(Date date);

    /**
     * 
     * Get the day at position index.
     * 
     *
     * @param index the index
     *
     * @return the day
     */
    public abstract Object get(int index);

    /**
     * @return an iterator for the days
     */
    public abstract Iterator iterator();

    /**
     * @return the number of days in this model
     */
    public abstract int size();
    
    /**
     * Add an entry to the this model. 
     *  
     * @param entry the entry to be added
     */
    public abstract void addEntry(ScheduleEntry entry);
    
    /**
     * Remove an entry from this model
     * 
     * @param entry the entry to be removed
     */
    public abstract void removeEntry(ScheduleEntry entry);
    
    /**
     * Remove the currently selected entry from this model. If no entry
     * is currently selected, nothing should happen.
     */
    public abstract void removeSelectedEntry();
    
    /**
     * Reload the entries for the currently selected period
     */
    public abstract void refresh();
    
    /**
     * @return The timezone for which the model should be built
     */
    public abstract TimeZone getTimeZone();
    
    /**
     * @return true, if each day contains the same set of intervals
     */
    public abstract boolean containsRepeatedIntervals();
}
//The End