org.quartz.Calendar Maven / Gradle / Ivy
/*
* Copyright 2004-2005 OpenSymphony
*
* Licensed 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.
*
*/
/*
* Previously Copyright (c) 2001-2004 James House
*/
package org.quartz;
/**
*
* An interface to be implemented by objects that define spaces of time that
* should be included or excluded from a {@link Trigger}'s
* normal 'firing' schedule.
*
*
* @author James House
* @author Juergen Donnerstag
*/
public interface Calendar extends java.io.Serializable {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Constants.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
int MONTH = 0;
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Set a new base calendar or remove the existing one.
*
*/
public void setBaseCalendar(Calendar baseCalendar);
/**
*
* Get the base calendar. Will be null, if not set.
*
*/
public Calendar getBaseCalendar();
/**
*
* Determine whether the given time (in milliseconds) is 'included' by the
* Calendar.
*
*/
public boolean isTimeIncluded(long timeStamp);
/**
*
* Determine the next time (in milliseconds) that is 'included' by the
* Calendar after the given time.
*
*/
public long getNextIncludedTime(long timeStamp);
/**
*
* Return the description given to the Calendar instance by
* its creator (if any).
*
*
* @return null if no description was set.
*/
public String getDescription();
/**
*
* Set a description for the Calendar instance - may be
* useful for remembering/displaying the purpose of the calendar, though
* the description has no meaning to Quartz.
*
*/
public void setDescription(String description);
}