RecordingState.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.capture.admin.api;

import java.util.Arrays;
import java.util.List;

/**
 * A representation of a recording's current state (MH-1475).
 */
public interface RecordingState {

  /** Constant <code>UNKNOWN="unknown"</code> */
  String UNKNOWN = "unknown";

  /** Constant <code>CAPTURING="capturing"</code> */
  String CAPTURING = "capturing";

  /** Constant <code>CAPTURE_FINISHED="capture_finished"</code> */
  String CAPTURE_FINISHED = "capture_finished";

  /** Constant <code>CAPTURE_ERROR="capture_error"</code> */
  String CAPTURE_ERROR = "capture_error";

  /** Constant <code>MANIFEST="manifest"</code> */
  String MANIFEST = "manifest";

  /** Constant <code>MANIFEST_ERROR="manifest_error"</code> */
  String MANIFEST_ERROR = "manifest_error";

  /** Constant <code>MANIFEST_FINISHED="manifest_finished"</code> */
  String MANIFEST_FINISHED = "manifest_finished";

  /** Constant <code>COMPRESSING="compressing"</code> */
  String COMPRESSING = "compressing";

  /** Constant <code>COMPRESSING_ERROR="compressing_error"</code> */
  String COMPRESSING_ERROR = "compressing_error";

  /** Constant <code>UPLOADING="uploading"</code> */
  String UPLOADING = "uploading";

  /** Constant <code>UPLOAD_FINISHED="upload_finished"</code> */
  String UPLOAD_FINISHED = "upload_finished";

  /** Constant <code>UPLOAD_ERROR="upload_error"</code> */
  String UPLOAD_ERROR = "upload_error";

  /** The collection of all known states. TODO: Remove this when the states are replaced with enums */
  List<String> KNOWN_STATES = Arrays.asList(new String[] { UNKNOWN, CAPTURING, CAPTURE_FINISHED, CAPTURE_ERROR,
          MANIFEST, MANIFEST_ERROR, MANIFEST_FINISHED, COMPRESSING, COMPRESSING_ERROR, UPLOADING, UPLOAD_FINISHED,
          UPLOAD_ERROR });

  /** Some of the known states should not be delivered to the workflow service */
  List<String> WORKFLOW_IGNORE_STATES = Arrays.asList(new String[] { UPLOADING, UPLOAD_FINISHED, UPLOAD_ERROR });

}