trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/scheduling/UsecaseScheduler.java

/*
 * 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.lenya.cms.usecase.scheduling;

import java.util.Date;

import org.apache.cocoon.components.cron.JobSchedulerEntry;
import org.apache.lenya.cms.usecase.Usecase;

/**
 * Service to schedule usecases.
 * 
 * @version $Id$
 */
public interface UsecaseScheduler {
    
    /**
     * The Avalon role.
     */
    String ROLE = UsecaseScheduler.class.getName();

    /**
     * Schedules a usecase at a certain date.
     * @param usecase The usecase.
     * @param date The invocation date.
     */
    void schedule(Usecase usecase, Date date);
    
    /**
     * @return All scheduled jobs.
     */
    JobSchedulerEntry[] getJobs();
}