javax.tv.service.transport.Network Maven / Gradle / Ivy

Go to download
/*
 * @(#)Network.java	1.15 00/09/27
 *
 * Copyright 1998-2000 by Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 * 
 * This software is the confidential and proprietary information
 * of Sun Microsystems, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Sun.
 */

package javax.tv.service.transport;

import javax.tv.service.*;

/**
 * This interface provides descriptive information concerning a network.
 */
public interface Network extends SIElement {
	
  /**
   * Reports the ID of this network.
   *
   * @return A number identifying this network.
   */
  public abstract int getNetworkID();
	
  /**
   * Reports the name of this network.
   *
   * @return A string representing the name of this network, or an empty
   * string if the name is unavailable.
   */
  public abstract String getName();
  
  /**
   * Retrieves an array of TransportStream objects
   * representing the transport streams carried in this
   * Network. Only TransportStream instances
   * ts for which the caller has
   * javax.tv.service.ReadPermission(ts.getLocator())
   * will be present in the array. If no TransportStream
   * instances meet this criteria or if this Network does
   * not aggregate transport streams, the result is an
   * SIRequestFailureType of
   * DATA_UNAVAILABLE.
   * 
   * This method delivers its results asynchronously.
   *
   * @param requestor The SIRequestor to be notified
   * when this retrieval operation completes.
   * 
   * @return An SIRequest object identifying this
   * asynchronous retrieval request.
   *
   * @see TransportStream
   * @see javax.tv.service.ReadPermission
   */
  public abstract SIRequest retrieveTransportStreams(SIRequestor requestor);
}