001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 * 
010 *      http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.oozie.client;
019
020import java.util.Date;
021import java.util.List;
022
023/**
024 * Bean that represents an Oozie bundle.
025 */
026public interface BundleJob extends Job {
027
028    /**
029     * Defines the possible frequency unit of all Oozie applications in Bundle.
030     */
031    public static enum Timeunit {
032        MINUTE, HOUR, DAY, WEEK, MONTH, END_OF_DAY, END_OF_MONTH, NONE
033    }
034
035    /**
036     * Return the timeUnit for the Bundle job, it could be, Timeunit enum, e.g. MINUTE, HOUR, DAY, WEEK or MONTH
037     *
038     * @return the time unit for the Bundle job
039     */
040    Timeunit getTimeUnit();
041
042    /**
043     * Return the time out value for all the coord jobs within Bundle
044     *
045     * @return the time out value for the coord jobs within Bundle
046     */
047    int getTimeout();
048
049    /**
050     * Return the list of CoordinatorJob.
051     *
052     * @return the list of CoordinatorJob.
053     */
054    List<CoordinatorJob> getCoordinators();
055    
056    /**
057     * Return the JOB Kickoff time.
058     *
059     * @return the JOB Kickoff time.
060     */
061    Date getKickoffTime();
062
063    /**
064     * Get createdTime
065     *
066     * @return createdTime
067     */
068    public Date getCreatedTime();
069
070}