MultimediaContent.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.metadata.mpeg7;

import org.opencastproject.mediapackage.XmlElement;

import java.util.Iterator;

/**
 * TODO: Comment me!
 */
public interface MultimediaContent<T extends MultimediaContentType> extends XmlElement {

  /**
   * Multimedia content type definitions.
   */
  enum Type {
    VideoType, AudioType, AudioVisualType
  };

  /**
   * Returns the multimedia content type.
   *
   * @return the type
   */
  MultimediaContent.Type getType();

  /**
   * Returns the content elements that are enclosed in a multimedia content container.
   *
   * @return the multimedia content elements
   */
  Iterator<T> elements();

  /**
   * Returns the content element with the given identifier or <code>null</code> if element does not exist.
   *
   * @param id
   *          the element identifier
   * @return the content element
   */
  T getElementById(String id);

  /**
   * Returns the number of content elements.
   *
   * @return the number of content elements
   */
  int size();

}