JobContext.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.job.api;

import java.util.Map;

/**
 * Runtime contextual information to be passed around with jobs.
 */
public interface JobContext {

  // /**
  // * Returns the identifier of the parent job or <code>null</code> if there is no parent job.
  // *
  // * @return the parent job identifier
  // */
  // Long getParentJobId();
  //
  // /**
  // * Returns the user that is associated with the job.
  // *
  // * @return the user id
  // */
  // String getUserId();

  /**
   * Gets the job context identifier.
   *
   * @return the job context identifier
   */
  Long getId();

  /**
   * Returns any additional contextual data.
   *
   * @return the contextual data
   */
  Map<String, String> getProperties();

}