001    // Copyright 2011 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    // http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.ioc.services.cron;
016    
017    /**
018     * @since 5.3
019     */
020    public interface PeriodicJob
021    {
022        /**
023         * Returns the name for the job, supplied when the job is created; this is not unique or meaningful, and
024         * primarily exists to assist with debugging.
025         *
026         * @return name provided for the job
027         */
028        String getName();
029    
030        /**
031         * Is this Job currently executing (or queued, awaiting execution)?
032         *
033         * @return true if executing
034         */
035        boolean isExecuting();
036    
037        /**
038         * Has this job been canceled.
039         */
040        boolean isCanceled();
041    
042        /**
043         * Cancels the job. If currently executing, the Job will finish (this includes awaiting execution). If not currently
044         * executing, the job is discarded immediately.
045         */
046        void cancel();
047    }